amazonka-grafana-2.0: Amazon Managed Grafana SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Grafana.UpdateWorkspaceAuthentication

Description

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.

Synopsis

Creating a Request

data UpdateWorkspaceAuthentication Source #

See: newUpdateWorkspaceAuthentication smart constructor.

Constructors

UpdateWorkspaceAuthentication' 

Fields

Instances

Instances details
ToJSON UpdateWorkspaceAuthentication Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

ToHeaders UpdateWorkspaceAuthentication Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

ToPath UpdateWorkspaceAuthentication Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

ToQuery UpdateWorkspaceAuthentication Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

AWSRequest UpdateWorkspaceAuthentication Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

Generic UpdateWorkspaceAuthentication Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

Associated Types

type Rep UpdateWorkspaceAuthentication :: Type -> Type #

Read UpdateWorkspaceAuthentication Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

Show UpdateWorkspaceAuthentication Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

NFData UpdateWorkspaceAuthentication Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

Eq UpdateWorkspaceAuthentication Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

Hashable UpdateWorkspaceAuthentication Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

type AWSResponse UpdateWorkspaceAuthentication Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

type Rep UpdateWorkspaceAuthentication Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

type Rep UpdateWorkspaceAuthentication = D1 ('MetaData "UpdateWorkspaceAuthentication" "Amazonka.Grafana.UpdateWorkspaceAuthentication" "amazonka-grafana-2.0-1hXXW2cgZWZJGJ3AoD5xOB" 'False) (C1 ('MetaCons "UpdateWorkspaceAuthentication'" 'PrefixI 'True) (S1 ('MetaSel ('Just "samlConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SamlConfiguration)) :*: (S1 ('MetaSel ('Just "authenticationProviders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AuthenticationProviderTypes]) :*: S1 ('MetaSel ('Just "workspaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateWorkspaceAuthentication Source #

Create a value of UpdateWorkspaceAuthentication with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:samlConfiguration:UpdateWorkspaceAuthentication', updateWorkspaceAuthentication_samlConfiguration - If the workspace uses SAML, use this structure to 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.

$sel:authenticationProviders:UpdateWorkspaceAuthentication', updateWorkspaceAuthentication_authenticationProviders - Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

$sel:workspaceId:UpdateWorkspaceAuthentication', updateWorkspaceAuthentication_workspaceId - The ID of the workspace to update the authentication for.

Request Lenses

updateWorkspaceAuthentication_samlConfiguration :: Lens' UpdateWorkspaceAuthentication (Maybe SamlConfiguration) Source #

If the workspace uses SAML, use this structure to 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.

updateWorkspaceAuthentication_authenticationProviders :: Lens' UpdateWorkspaceAuthentication [AuthenticationProviderTypes] Source #

Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

updateWorkspaceAuthentication_workspaceId :: Lens' UpdateWorkspaceAuthentication Text Source #

The ID of the workspace to update the authentication for.

Destructuring the Response

data UpdateWorkspaceAuthenticationResponse Source #

Constructors

UpdateWorkspaceAuthenticationResponse' 

Fields

Instances

Instances details
Generic UpdateWorkspaceAuthenticationResponse Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

Read UpdateWorkspaceAuthenticationResponse Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

Show UpdateWorkspaceAuthenticationResponse Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

NFData UpdateWorkspaceAuthenticationResponse Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

Eq UpdateWorkspaceAuthenticationResponse Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

type Rep UpdateWorkspaceAuthenticationResponse Source # 
Instance details

Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication

type Rep UpdateWorkspaceAuthenticationResponse = D1 ('MetaData "UpdateWorkspaceAuthenticationResponse" "Amazonka.Grafana.UpdateWorkspaceAuthentication" "amazonka-grafana-2.0-1hXXW2cgZWZJGJ3AoD5xOB" 'False) (C1 ('MetaCons "UpdateWorkspaceAuthenticationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "authentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AuthenticationDescription)))

newUpdateWorkspaceAuthenticationResponse Source #

Create a value of UpdateWorkspaceAuthenticationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateWorkspaceAuthenticationResponse', updateWorkspaceAuthenticationResponse_httpStatus - The response's http status code.

UpdateWorkspaceAuthenticationResponse, updateWorkspaceAuthenticationResponse_authentication - A structure that describes the user authentication for this workspace after the update is made.

Response Lenses

updateWorkspaceAuthenticationResponse_authentication :: Lens' UpdateWorkspaceAuthenticationResponse AuthenticationDescription Source #

A structure that describes the user authentication for this workspace after the update is made.