Skip to main content

Add Apple Identity Provider

POST 
https://$CUSTOM-DOMAIN/admin/v1/idps/apple

Add Apple Identity Provider

Request​

Body

required

    name Apple will be used as default, if no name is provided (string)

    Possible values: <= 200 characters

    Apple will be used as default, if no name is provided

    clientId stringrequired

    Possible values: non-empty and <= 200 characters

    Client id (App ID or Service ID) provided by Apple

    teamId stringrequired

    Possible values: >= 10 characters and <= 10 characters

    (10-character) Team ID provided by Apple

    keyId stringrequired

    Possible values: >= 10 characters and <= 10 characters

    (10-character) ID of the private key generated by Apple

    privateKey byterequired

    Possible values: non-empty and <= 5000 characters

    Private Key generated by Apple

    scopes string[]

    Possible values: <= 20

    The scopes requested by ZITADEL during the request to Apple

    providerOptions

    object

    isLinkingAllowed boolean

    Enable if users should be able to manually link an existing ZITADEL user with an external account. Disable if users should only be allowed to link the proposed account in case of active auto_linking.

    isCreationAllowed boolean

    Enable if users should be able to manually create a new account in ZITADEL when using an external account. Disable if users should not be able to edit account information when auto_creation is enabled.

    isAutoCreation boolean

    Enable if a new account in ZITADEL should be created automatically when login with an external account.

    isAutoUpdate boolean

    Enable if a the ZITADEL account fields should be updated automatically on each login.

    autoLinking string

    Possible values: [AUTO_LINKING_OPTION_UNSPECIFIED, AUTO_LINKING_OPTION_USERNAME, AUTO_LINKING_OPTION_EMAIL]

    Default value: AUTO_LINKING_OPTION_UNSPECIFIED

    Enable if users should get prompted to link an existing ZITADEL user to an external account if the selected attribute matches.

Responses​

A successful response.

Schema

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to (string)
    id string
curl -L 'https://$CUSTOM-DOMAIN/admin/v1/idps/apple' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "name": "Apple",
  "clientId": "client-id",
  "teamId": "ALT03JV3OS",
  "keyId": "OGKDK25KD",
  "privateKey": "LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1...",
  "scopes": [
    "name",
    "email"
  ],
  "providerOptions": {
    "isLinkingAllowed": true,
    "isCreationAllowed": true,
    "isAutoCreation": true,
    "isAutoUpdate": true,
    "autoLinking": "AUTO_LINKING_OPTION_UNSPECIFIED"
  }
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/admin/v1
Auth
Body required
{
  "name": "Apple",
  "clientId": "client-id",
  "teamId": "ALT03JV3OS",
  "keyId": "OGKDK25KD",
  "privateKey": "LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1...",
  "scopes": [
    "name",
    "email"
  ],
  "providerOptions": {
    "isLinkingAllowed": true,
    "isCreationAllowed": true,
    "isAutoCreation": true,
    "isAutoUpdate": true,
    "autoLinking": "AUTO_LINKING_OPTION_UNSPECIFIED"
  }
}
ResponseClear

Click the Send API Request button above and see the response here!