Authentication by Apple

Gets the Apple login URL.

get

Query parameters

callbackURLstringRequired

The callback URL that the user will be redirected to after logging in.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Responses

200

The request was successful.

application/json

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

datastring · nullableOptional

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/users/auth/integrations/apple/authenticate-url

HTTPcURLJavaScriptPython

GET /api/v1/users/auth/integrations/apple/authenticate-url?callbackURL=text HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": "https://appleid.apple.com/auth/authorize?response_type=code%20id_token&client_id=&redirect_uri=&state=h80GhRPZ52OoDZzVbhOfJhJgdno%2FOhA2eUjyVRsWDDNxwMKvfe%2BkHIoKJLeyVEtFQCbaQf3sONqQTJ3PhcioIQ%3D%3D&Scope=openid%20email%20name&response_mode=form_post",
  "errors": []
}