workspace_authentications

Creates, updates, deletes, gets or lists a workspace_authentications resource.

Overview

Name	workspace_authentications
Type	Resource
Id	aws.grafana.workspace_authentications

Fields

The following fields are returned by SELECT queries:

describe_workspace_authentication

Name	Datatype	Description
aws_sso	object	A structure containing information about how this workspace works with IAM Identity Center.
providers	array	Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.
saml	object	A structure containing information about how this workspace works with SAML, including what attributes within the assertion are to be mapped to user information in the workspace.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_workspace_authentication	select	workspace_id, region		Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
update_workspace_authentication	update	workspace_id, region, authenticationProviders		Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML. You can also map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace. Changes to the authentication method for a workspace may take a few minutes to take effect.

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
region	string	AWS region (default: us-east-1)
workspace_id	string	The ID of the workspace to update the authentication for.

SELECT examples

describe_workspace_authentication

Displays information about the authentication methods used in one Amazon Managed Grafana workspace.

SELECT
aws_sso,
providers,
saml
FROM aws.grafana.workspace_authentications
WHERE workspace_id = '{{ workspace_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_workspace_authentication

Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML. You can also map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace. Changes to the authentication method for a workspace may take a few minutes to take effect.

UPDATE aws.grafana.workspace_authentications
SET 
authenticationProviders = '{{ authenticationProviders }}',
samlConfiguration = '{{ samlConfiguration }}'
WHERE 
workspace_id = '{{ workspace_id }}' --required
AND region = '{{ region }}' --required
AND authenticationProviders = '{{ authenticationProviders }}' --required
RETURNING
authentication;