Add Apple Identity Provider​
Add Apple Identity Provider
Request Body required
Possible values: <= 200 characters
Apple will be used as default, if no name is provided
Possible values: non-empty
and <= 200 characters
Client id (App ID or Service ID) provided by Apple
Possible values: >= 10 characters
and <= 10 characters
(10-character) Team ID provided by Apple
Possible values: >= 10 characters
and <= 10 characters
(10-character) ID of the private key generated by Apple
Possible values: non-empty
and <= 5000 characters
Private Key generated by Apple
Possible values: <= 20
The scopes requested by ZITADEL during the request to Apple
providerOptions object
Enable if users should be able to link an existing ZITADEL user with an external account.
Enable if users should be able to create a new account in ZITADEL when using an external account.
Enable if a new account in ZITADEL should be created automatically when login with an external account.
Enable if a the ZITADEL account fields should be updated automatically on each login.
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.
Request Body required
Possible values: <= 200 characters
Apple will be used as default, if no name is provided
Possible values: non-empty
and <= 200 characters
Client id (App ID or Service ID) provided by Apple
Possible values: >= 10 characters
and <= 10 characters
(10-character) Team ID provided by Apple
Possible values: >= 10 characters
and <= 10 characters
(10-character) ID of the private key generated by Apple
Possible values: non-empty
and <= 5000 characters
Private Key generated by Apple
Possible values: <= 20
The scopes requested by ZITADEL during the request to Apple
providerOptions object
Enable if users should be able to link an existing ZITADEL user with an external account.
Enable if users should be able to create a new account in ZITADEL when using an external account.
Enable if a new account in ZITADEL should be created automatically when login with an external account.
Enable if a the ZITADEL account fields should be updated automatically on each login.
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.
Request Body required
Possible values: <= 200 characters
Apple will be used as default, if no name is provided
Possible values: non-empty
and <= 200 characters
Client id (App ID or Service ID) provided by Apple
Possible values: >= 10 characters
and <= 10 characters
(10-character) Team ID provided by Apple
Possible values: >= 10 characters
and <= 10 characters
(10-character) ID of the private key generated by Apple
Possible values: non-empty
and <= 5000 characters
Private Key generated by Apple
Possible values: <= 20
The scopes requested by ZITADEL during the request to Apple
providerOptions object
Enable if users should be able to link an existing ZITADEL user with an external account.
Enable if users should be able to create a new account in ZITADEL when using an external account.
Enable if a new account in ZITADEL should be created automatically when login with an external account.
Enable if a the ZITADEL account fields should be updated automatically on each login.
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.
- 200
- 403
- 404
- default
A successful response.
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:38.981Z",
"changeDate": "2024-06-13T06:44:38.981Z",
"resourceOwner": "69629023906488334"
},
"id": "string"
}
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:38.981Z",
"changeDate": "2024-06-13T06:44:38.981Z",
"resourceOwner": "69629023906488334"
},
"id": "string"
}
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:38.981Z",
"changeDate": "2024-06-13T06:44:38.981Z",
"resourceOwner": "69629023906488334"
},
"id": "string"
}
Returned when the user does not have permission to access the resource.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}