> For the complete documentation index, see [llms.txt](https://docs.thewalletcrew.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.thewalletcrew.io/api-reference/advanced/apple-sign-in.md).

# Apple Sign In

## Get sign in with Apple settings

> Returns the \`serviceIdentifier\` field of \`server/apple.yml\`.

```json
{"openapi":"3.1.1","info":{"title":"Neostore internal API","version":"v1"},"tags":[{"name":"AppleSignIn"}],"servers":[{"url":"https://app.neostore.cloud","description":"Production Server"},{"url":"https://app-qa.neostore.cloud","description":"Staging Server"}],"security":[{"admin-bearer":["tenant.configuration.connector.social:read"]},{"apiKey":[]}],"components":{"securitySchemes":{"admin-bearer":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://auth.neostore.cloud/authorize?audience=https://app.neostore.cloud/api/","scopes":{}}}},"apiKey":{"type":"apiKey","name":"X-API-KEY","in":"header"}},"schemas":{"AppleSignInDefinition":{"required":["serviceIdentifier"],"type":"object","properties":{"serviceIdentifier":{"type":"string","description":"Identifier for the service ID where \"Sign in with Apple\" is configured."}},"additionalProperties":false,"description":"Sign in with Apple settings."},"ProblemDetails":{"type":"object","properties":{"type":{"type":["null","string"]},"title":{"type":["null","string"]},"status":{"type":["null","integer"],"format":"int32"},"detail":{"type":["null","string"]},"instance":{"type":["null","string"]}},"additionalProperties":{}},"HttpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/ProblemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"additionalProperties":{}}}},"paths":{"/api/{tenantId}/admin/socialSignIn/apple":{"get":{"tags":["AppleSignIn"],"summary":"Get sign in with Apple settings","description":"Returns the `serviceIdentifier` field of `server/apple.yml`.","parameters":[{"name":"tenantId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Settings returned.","content":{"text/plain":{"schema":{"description":"Sign in with Apple settings.","$ref":"#/components/schemas/AppleSignInDefinition"}},"application/json":{"schema":{"description":"Sign in with Apple settings.","$ref":"#/components/schemas/AppleSignInDefinition"}},"text/json":{"schema":{"description":"Sign in with Apple settings.","$ref":"#/components/schemas/AppleSignInDefinition"}}}},"404":{"description":"Sign in with Apple is not configured.","content":{"text/plain":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}},"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}},"text/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}}}}}}}
```

## Configure sign in with 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.

```json
{"openapi":"3.1.1","info":{"title":"Neostore internal API","version":"v1"},"tags":[{"name":"AppleSignIn"}],"servers":[{"url":"https://app.neostore.cloud","description":"Production Server"},{"url":"https://app-qa.neostore.cloud","description":"Staging Server"}],"security":[{"admin-bearer":["tenant.configuration.connector.social:write"]},{"apiKey":[]}],"components":{"securitySchemes":{"admin-bearer":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://auth.neostore.cloud/authorize?audience=https://app.neostore.cloud/api/","scopes":{}}}},"apiKey":{"type":"apiKey","name":"X-API-KEY","in":"header"}},"schemas":{"UpdateAppleSignInRequest":{"required":["serviceIdentifier"],"type":"object","properties":{"serviceIdentifier":{"minLength":1,"type":"string","description":"Identifier for the service ID where \"Sign in with Apple\" is configured."}},"additionalProperties":false,"description":"Request body to configure sign in with Apple."},"AppleSignInDefinition":{"required":["serviceIdentifier"],"type":"object","properties":{"serviceIdentifier":{"type":"string","description":"Identifier for the service ID where \"Sign in with Apple\" is configured."}},"additionalProperties":false,"description":"Sign in with Apple settings."},"ProblemDetails":{"type":"object","properties":{"type":{"type":["null","string"]},"title":{"type":["null","string"]},"status":{"type":["null","integer"],"format":"int32"},"detail":{"type":["null","string"]},"instance":{"type":["null","string"]}},"additionalProperties":{}},"HttpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/ProblemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"additionalProperties":{}}}},"paths":{"/api/{tenantId}/admin/socialSignIn/apple":{"put":{"tags":["AppleSignIn"],"summary":"Configure sign in with Apple","description":"Replaces the `serviceIdentifier` field, leaving the Apple Wallet fields of the file untouched.\nApple Wallet must already be configured for the tenant, since the wallet fields of\n`server/apple.yml` are required and cannot be filled in from this endpoint.","parameters":[{"name":"tenantId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Request body to configure sign in with Apple.","$ref":"#/components/schemas/UpdateAppleSignInRequest"}},"text/json":{"schema":{"description":"Request body to configure sign in with Apple.","$ref":"#/components/schemas/UpdateAppleSignInRequest"}},"application/*+json":{"schema":{"description":"Request body to configure sign in with Apple.","$ref":"#/components/schemas/UpdateAppleSignInRequest"}}},"required":true},"responses":{"200":{"description":"Settings updated.","content":{"text/plain":{"schema":{"description":"Sign in with Apple settings.","$ref":"#/components/schemas/AppleSignInDefinition"}},"application/json":{"schema":{"description":"Sign in with Apple settings.","$ref":"#/components/schemas/AppleSignInDefinition"}},"text/json":{"schema":{"description":"Sign in with Apple settings.","$ref":"#/components/schemas/AppleSignInDefinition"}}}},"409":{"description":"Apple Wallet is not yet configured for this tenant; configure it first.","content":{"text/plain":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}},"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}},"text/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}}}}}}}
```

## Delete sign in with Apple settings

> 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.

```json
{"openapi":"3.1.1","info":{"title":"Neostore internal API","version":"v1"},"tags":[{"name":"AppleSignIn"}],"servers":[{"url":"https://app.neostore.cloud","description":"Production Server"},{"url":"https://app-qa.neostore.cloud","description":"Staging Server"}],"security":[{"admin-bearer":["tenant.configuration.connector.social:write"]},{"apiKey":[]}],"components":{"securitySchemes":{"admin-bearer":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://auth.neostore.cloud/authorize?audience=https://app.neostore.cloud/api/","scopes":{}}}},"apiKey":{"type":"apiKey","name":"X-API-KEY","in":"header"}}},"paths":{"/api/{tenantId}/admin/socialSignIn/apple":{"delete":{"tags":["AppleSignIn"],"summary":"Delete sign in with Apple settings","description":"Clears the `serviceIdentifier` field of `server/apple.yml`, disabling sign in with Apple for\nthe tenant. This bypasses the ServiceIdentifier required-field validation enforced on `PUT`, since\na delete does not require a valid configuration.\n            \nThe Apple Wallet fields of the file are preserved.","parameters":[{"name":"tenantId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Configuration deleted."}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.thewalletcrew.io/api-reference/advanced/apple-sign-in.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.