Authentication by Apple

PreviousAssigns roles to a user NextAuthentication by email OTP

Last updated 2 months ago

Was this helpful?

Gets the Apple login URL.

get

Query parameters

callbackUrlstringRequired

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

Header parameters

BrandUrlstringRequired

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

429

The user has exceeded the rate limit.

application/json

get

GET /api/v1/users/auth/integrations/apple/authenticate-url HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: 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": []
}