Creates an identity provider resource that is then associated with a web portal¶
Description¶
Creates an identity provider resource that is then associated with a web portal.
Usage¶
workspacesweb_create_identity_provider(portalArn, identityProviderName,
identityProviderType, identityProviderDetails, clientToken, tags)
Arguments¶
-
portalArn[required] The ARN of the web portal.
-
identityProviderName[required] The identity provider name.
-
identityProviderType[required] The identity provider type.
-
identityProviderDetails[required] The identity provider details. The following list describes the provider detail keys for each identity provider type.
-
For Google and Login with Amazon:
client_idclient_secret-
authorize_scopes- For Facebook:
-
client_id client_secretauthorize_scopes-
api_version- For Sign in with Apple:
-
client_id team_idkey_idprivate_key-
authorize_scopes- For OIDC providers:
-
client_id client_secretattributes_request_methodoidc_issuerauthorize_scopesauthorize_urlif not available from discovery URL specified by oidc_issuer keytoken_urlif not available from discovery URL specified by oidc_issuer keyattributes_urlif not available from discovery URL specified by oidc_issuer key-
jwks_uriif not available from discovery URL specified by oidc_issuer key- For SAML providers:
-
MetadataFileORMetadataURL IDPSignout(boolean) optionalIDPInit(boolean) optionalRequestSigningAlgorithm(string) optional - Only acceptsrsa-sha256EncryptedResponses(boolean) optional
-
-
clientTokenA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
-
tagsThe tags to add to the identity provider resource. A tag is a key-value pair.
Value¶
A list with the following syntax:
Request syntax¶
svc$create_identity_provider(
portalArn = "string",
identityProviderName = "string",
identityProviderType = "SAML"|"Facebook"|"Google"|"LoginWithAmazon"|"SignInWithApple"|"OIDC",
identityProviderDetails = list(
"string"
),
clientToken = "string",
tags = list(
list(
Key = "string",
Value = "string"
)
)
)