Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Grafana.UpdateWorkspaceAuthentication

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

samlConfiguration :: Maybe 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.
authenticationProviders :: [AuthenticationProviderTypes]
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.
workspaceId :: Text
The ID of the workspace to update the authentication for.

Instances

Instances details

ToJSON UpdateWorkspaceAuthentication Source #
Instance details Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication Methods toJSON :: UpdateWorkspaceAuthentication -> Value # toEncoding :: UpdateWorkspaceAuthentication -> Encoding # toJSONList :: [UpdateWorkspaceAuthentication] -> Value # toEncodingList :: [UpdateWorkspaceAuthentication] -> Encoding #
ToHeaders UpdateWorkspaceAuthentication Source #
Instance details Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication Methods toHeaders :: UpdateWorkspaceAuthentication -> [Header] #
ToPath UpdateWorkspaceAuthentication Source #
Instance details Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication Methods toPath :: UpdateWorkspaceAuthentication -> ByteString #
ToQuery UpdateWorkspaceAuthentication Source #
Instance details Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication Methods toQuery :: UpdateWorkspaceAuthentication -> QueryString #
AWSRequest UpdateWorkspaceAuthentication Source #
Instance details Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication Associated Types type AWSResponse UpdateWorkspaceAuthentication # Methods request :: (Service -> Service) -> UpdateWorkspaceAuthentication -> Request UpdateWorkspaceAuthentication # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateWorkspaceAuthentication -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateWorkspaceAuthentication))) #
Generic UpdateWorkspaceAuthentication Source #
Instance details Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication Associated Types type Rep UpdateWorkspaceAuthentication :: Type -> Type # Methods from :: UpdateWorkspaceAuthentication -> Rep UpdateWorkspaceAuthentication x # to :: Rep UpdateWorkspaceAuthentication x -> UpdateWorkspaceAuthentication #
Read UpdateWorkspaceAuthentication Source #
Instance details Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication Methods readsPrec :: Int -> ReadS UpdateWorkspaceAuthentication # readList :: ReadS [UpdateWorkspaceAuthentication] # readPrec :: ReadPrec UpdateWorkspaceAuthentication # readListPrec :: ReadPrec [UpdateWorkspaceAuthentication] #
Show UpdateWorkspaceAuthentication Source #
Instance details Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication Methods showsPrec :: Int -> UpdateWorkspaceAuthentication -> ShowS # show :: UpdateWorkspaceAuthentication -> String # showList :: [UpdateWorkspaceAuthentication] -> ShowS #
NFData UpdateWorkspaceAuthentication Source #
Instance details Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication Methods rnf :: UpdateWorkspaceAuthentication -> () #
Eq UpdateWorkspaceAuthentication Source #
Instance details Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication Methods (==) :: UpdateWorkspaceAuthentication -> UpdateWorkspaceAuthentication -> Bool # (/=) :: UpdateWorkspaceAuthentication -> UpdateWorkspaceAuthentication -> Bool #
Hashable UpdateWorkspaceAuthentication Source #
Instance details Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication Methods hashWithSalt :: Int -> UpdateWorkspaceAuthentication -> Int # hash :: UpdateWorkspaceAuthentication -> Int #
type AWSResponse UpdateWorkspaceAuthentication Source #
Instance details Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication type AWSResponse UpdateWorkspaceAuthentication = UpdateWorkspaceAuthenticationResponse
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 #

Arguments

:: Text	`$sel:workspaceId:UpdateWorkspaceAuthentication'`
-> UpdateWorkspaceAuthentication

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 #

See: newUpdateWorkspaceAuthenticationResponse smart constructor.

Constructors

UpdateWorkspaceAuthenticationResponse'
Fields httpStatus :: Int The response's http status code. authentication :: AuthenticationDescription A structure that describes the user authentication for this workspace after the update is made.

Instances

Instances details

Generic UpdateWorkspaceAuthenticationResponse Source #
Instance details Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication Associated Types type Rep UpdateWorkspaceAuthenticationResponse :: Type -> Type # Methods from :: UpdateWorkspaceAuthenticationResponse -> Rep UpdateWorkspaceAuthenticationResponse x # to :: Rep UpdateWorkspaceAuthenticationResponse x -> UpdateWorkspaceAuthenticationResponse #
Read UpdateWorkspaceAuthenticationResponse Source #
Instance details Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication Methods readsPrec :: Int -> ReadS UpdateWorkspaceAuthenticationResponse # readList :: ReadS [UpdateWorkspaceAuthenticationResponse] # readPrec :: ReadPrec UpdateWorkspaceAuthenticationResponse # readListPrec :: ReadPrec [UpdateWorkspaceAuthenticationResponse] #
Show UpdateWorkspaceAuthenticationResponse Source #
Instance details Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication Methods showsPrec :: Int -> UpdateWorkspaceAuthenticationResponse -> ShowS # show :: UpdateWorkspaceAuthenticationResponse -> String # showList :: [UpdateWorkspaceAuthenticationResponse] -> ShowS #
NFData UpdateWorkspaceAuthenticationResponse Source #
Instance details Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication Methods rnf :: UpdateWorkspaceAuthenticationResponse -> () #
Eq UpdateWorkspaceAuthenticationResponse Source #
Instance details Defined in Amazonka.Grafana.UpdateWorkspaceAuthentication Methods (==) :: UpdateWorkspaceAuthenticationResponse -> UpdateWorkspaceAuthenticationResponse -> Bool # (/=) :: UpdateWorkspaceAuthenticationResponse -> UpdateWorkspaceAuthenticationResponse -> Bool #
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 #

Arguments

:: Int	`$sel:httpStatus:UpdateWorkspaceAuthenticationResponse'`
-> AuthenticationDescription	`UpdateWorkspaceAuthenticationResponse`
-> UpdateWorkspaceAuthenticationResponse

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_httpStatus :: Lens' UpdateWorkspaceAuthenticationResponse Int Source #

The response's http status code.

updateWorkspaceAuthenticationResponse_authentication :: Lens' UpdateWorkspaceAuthenticationResponse AuthenticationDescription Source #

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