identity_providers

Creates, updates, deletes, gets or lists an identity_providers resource.

Overview

Name	identity_providers
Type	Resource
Id	aws.workspaces_web.identity_providers

Fields

The following fields are returned by SELECT queries:

get_identity_provider

Name	Datatype	Description
identity_provider_arn	string	The ARN of the identity provider. (pattern: <code>arn:[\w+=/,.@-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(/[a-fA-F0-9-]{36}){2,}</code>)
identity_provider_details	object	The identity provider details. 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 key token_url if not available from discovery URL specified by oidc_issuer key attributes_url if not available from discovery URL specified by oidc_issuer key jwks_uri if not available from discovery URL specified by oidc_issuer key For SAML providers: MetadataFile OR MetadataURL IDPSignout (boolean) optional IDPInit (boolean) optional RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256 EncryptedResponses (boolean) optional
identity_provider_name	string	The identity provider name. (pattern: <code>[^][\p{L}\p{M}\p{S}\p{N}\p{P}][^]+</code>)
identity_provider_type	string	The identity provider type. (SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC)

list_identity_providers

Name	Datatype	Description
identity_providers	array	The identity providers.
next_token	string	The pagination token used to retrieve the next page of results for this operation. (pattern: <code>\S+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_identity_provider	select	identity_provider_arn, region		Gets the identity provider.
list_identity_providers	select	portal_arn, region	nextToken, maxResults	Retrieves a list of identity providers for a specific web portal.
create_identity_provider	insert	region, portalArn, identityProviderName, identityProviderType, identityProviderDetails		Creates an identity provider resource that is then associated with a web portal.
update_identity_provider	update	identity_provider_arn, region		Updates the identity provider.
delete_identity_provider	delete	identity_provider_arn, region		Deletes the identity provider.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
identity_provider_arn	string	The ARN of the identity provider.
portal_arn	string	The ARN of the web portal.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to be included in the next page.
nextToken	string	The pagination token used to retrieve the next page of results for this operation.

SELECT examples

get_identity_provider

Gets the identity provider.

SELECT
identity_provider_arn,
identity_provider_details,
identity_provider_name,
identity_provider_type
FROM aws.workspaces_web.identity_providers
WHERE identity_provider_arn = '{{ identity_provider_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_identity_providers

Retrieves a list of identity providers for a specific web portal.

SELECT
identity_providers,
next_token
FROM aws.workspaces_web.identity_providers
WHERE portal_arn = '{{ portal_arn }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_identity_provider

Creates an identity provider resource that is then associated with a web portal.

INSERT INTO aws.workspaces_web.identity_providers (
portalArn,
identityProviderName,
identityProviderType,
identityProviderDetails,
clientToken,
tags,
region
)
SELECT 
'{{ portalArn }}' /* required */,
'{{ identityProviderName }}' /* required */,
'{{ identityProviderType }}' /* required */,
'{{ identityProviderDetails }}' /* required */,
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
identity_provider_arn
;

Manifest

# Description fields are for documentation purposes
- name: identity_providers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the identity_providers resource.
  - name: portalArn
    value: "{{ portalArn }}"
  - name: identityProviderName
    value: "{{ identityProviderName }}"
  - name: identityProviderType
    value: "{{ identityProviderType }}"
    valid_values: ['SAML', 'Facebook', 'Google', 'LoginWithAmazon', 'SignInWithApple', 'OIDC']
  - name: identityProviderDetails
    value: "{{ identityProviderDetails }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_identity_provider

Updates the identity provider.

UPDATE aws.workspaces_web.identity_providers
SET 
identityProviderName = '{{ identityProviderName }}',
identityProviderType = '{{ identityProviderType }}',
identityProviderDetails = '{{ identityProviderDetails }}',
clientToken = '{{ clientToken }}'
WHERE 
identity_provider_arn = '{{ identity_provider_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
identity_provider;

DELETE examples

delete_identity_provider

Deletes the identity provider.

DELETE FROM aws.workspaces_web.identity_providers
WHERE identity_provider_arn = '{{ identity_provider_arn }}' --required
AND region = '{{ region }}' --required
;