Amazon WorkSpaces Web · Schema
IdentityProvider
The identity provider.
End User ComputingSecure BrowserVirtual DesktopZero Trust
Properties
| Name | Type | Description |
|---|---|---|
| identityProviderArn | object | |
| identityProviderDetails | object | |
| identityProviderName | object | |
| identityProviderType | object |
JSON Schema
{
"type": "object",
"required": [
"identityProviderArn"
],
"properties": {
"identityProviderArn": {
"allOf": [
{
"$ref": "#/components/schemas/ARN"
},
{
"description": "The ARN of the identity provider."
}
]
},
"identityProviderDetails": {
"allOf": [
{
"$ref": "#/components/schemas/IdentityProviderDetails"
},
{
"description": "<p>The identity provider details. The following list describes the provider detail keys for each identity provider type. </p> <ul> <li> <p>For Google and Login with Amazon:</p> <ul> <li> <p> <code>client_id</code> </p> </li> <li> <p> <code>client_secret</code> </p> </li> <li> <p> <code>authorize_scopes</code> </p> </li> </ul> </li> <li> <p>For Facebook:</p> <ul> <li> <p> <code>client_id</code> </p> </li> <li> <p> <code>client_secret</code> </p> </li> <li> <p> <code>authorize_scopes</code> </p> </li> <li> <p> <code>api_version</code> </p> </li> </ul> </li> <li> <p>For Sign in with Apple:</p> <ul> <li> <p> <code>client_id</code> </p> </li> <li> <p> <code>team_id</code> </p> </li> <li> <p> <code>key_id</code> </p> </li> <li> <p> <code>private_key</code> </p> </li> <li> <p> <code>authorize_scopes</code> </p> </li> </ul> </li> <li> <p>For OIDC providers:</p> <ul> <li> <p> <code>client_id</code> </p> </li> <li> <p> <code>client_secret</code> </p> </li> <li> <p> <code>attributes_request_method</code> </p> </li> <li> <p> <code>oidc_issuer</code> </p> </li> <li> <p> <code>authorize_scopes</code> </p> </li> <li> <p> <code>authorize_url</code> <i>if not available from discovery URL specified by oidc_issuer key</i> </p> </li> <li> <p> <code>token_url</code> <i>if not available from discovery URL specified by oidc_issuer key</i> </p> </li> <li> <p> <code>attributes_url</code> <i>if not available from discovery URL specified by oidc_issuer key</i> </p> </li> <li> <p> <code>jwks_uri</code> <i>if not available from discovery URL specified by oidc_issuer key</i> </p> </li> </ul> </li> <li> <p>For SAML providers:</p> <ul> <li> <p> <code>MetadataFile</code> OR <code>MetadataURL</code> </p> </li> <li> <p> <code>IDPSignout</code> <i>optional</i> </p> </li> </ul> </li> </ul>"
}
]
},
"identityProviderName": {
"allOf": [
{
"$ref": "#/components/schemas/IdentityProviderName"
},
{
"description": "The identity provider name."
}
]
},
"identityProviderType": {
"allOf": [
{
"$ref": "#/components/schemas/IdentityProviderType"
},
{
"description": "The identity provider type."
}
]
}
},
"description": "The identity provider.",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "IdentityProvider",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces-web/refs/heads/main/json-schema/workspaces-web-identity-provider-schema.json"
}