Update Identity Provider
workspacesweb_update_identity_provider | R Documentation |
Updates the identity provider¶
Description¶
Updates the identity provider.
Usage¶
workspacesweb_update_identity_provider(clientToken, identityProviderArn,
identityProviderDetails, identityProviderName, identityProviderType)
Arguments¶
clientToken
A 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 return 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.
identityProviderArn
[required] The ARN of the identity provider.
identityProviderDetails
The details of the identity provider. The following list describes the provider detail keys for each identity provider type.
For Google and Login with Amazon:
client_id
client_secret
authorize_scopes
For Facebook:
client_id
client_secret
authorize_scopes
api_version
For Sign in with Apple:
client_id
team_id
key_id
private_key
authorize_scopes
For OIDC providers:
client_id
client_secret
attributes_request_method
oidc_issuer
authorize_scopes
authorize_url
if not available from discovery URL specified by oidc_issuer keytoken_url
if not available from discovery URL specified by oidc_issuer keyattributes_url
if not available from discovery URL specified by oidc_issuer keyjwks_uri
if not available from discovery URL specified by oidc_issuer key
For SAML providers:
MetadataFile
ORMetadataURL
IDPSignout
(boolean) optionalIDPInit
(boolean) optionalRequestSigningAlgorithm
(string) optional - Only acceptsrsa-sha256
EncryptedResponses
(boolean) optional
identityProviderName
The name of the identity provider.
identityProviderType
The type of the identity provider.
Value¶
A list with the following syntax:
list(
identityProvider = list(
identityProviderArn = "string",
identityProviderDetails = list(
"string"
),
identityProviderName = "string",
identityProviderType = "SAML"|"Facebook"|"Google"|"LoginWithAmazon"|"SignInWithApple"|"OIDC"
)
)