This documentation is currently under development. Certain sections are not yet complete and will be added shortly.
Ctrlk
HomeDocumentationRessources
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Apple Sign In

Get sign in with Apple settings

get
/api/{tenantId}/admin/socialSignIn/apple

Returns the serviceIdentifier field of server/apple.yml.

Authorization

Requires tenant.configuration.connector.social:read scope.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
tenantIdstringRequired
Responses
200

Settings returned.

Sign in with Apple settings.

serviceIdentifierstringRequired

Identifier for the service ID where "Sign in with Apple" is configured.

get/api/{tenantId}/admin/socialSignIn/apple
GET /api/{tenantId}/admin/socialSignIn/apple HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "serviceIdentifier": "text"
}

Configure sign in with Apple

put
/api/{tenantId}/admin/socialSignIn/apple

Replaces the serviceIdentifier field, leaving the Apple Wallet fields of the file untouched. Apple Wallet must already be configured for the tenant, since the wallet fields of server/apple.yml are required and cannot be filled in from this endpoint.

Authorization

Requires tenant.configuration.connector.social:write scope.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
tenantIdstringRequired
Body

Request body to configure sign in with Apple.

serviceIdentifierstring · min: 1Required

Identifier for the service ID where "Sign in with Apple" is configured.

Responses
200

Settings updated.

Sign in with Apple settings.

serviceIdentifierstringRequired

Identifier for the service ID where "Sign in with Apple" is configured.

put/api/{tenantId}/admin/socialSignIn/apple
PUT /api/{tenantId}/admin/socialSignIn/apple HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "serviceIdentifier": "text"
}
{
  "serviceIdentifier": "text"
}

Delete sign in with Apple settings

delete
/api/{tenantId}/admin/socialSignIn/apple

Clears the serviceIdentifier field of server/apple.yml, disabling sign in with Apple for the tenant. This bypasses the ServiceIdentifier required-field validation enforced on PUT, since a delete does not require a valid configuration.

The Apple Wallet fields of the file are preserved.

Authorization

Requires tenant.configuration.connector.social:write scope.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
tenantIdstringRequired
Responses
204

Configuration deleted.

No content
delete/api/{tenantId}/admin/socialSignIn/apple
DELETE /api/{tenantId}/admin/socialSignIn/apple HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
204

Configuration deleted.

No content

Last updated