Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SSOOIDC.RegisterClient

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Registers a client with AWS SSO. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.

Synopsis

data RegisterClient = RegisterClient' {
- scopes :: Maybe [Text]
- clientName :: Text
- clientType :: Text
}
newRegisterClient :: Text -> Text -> RegisterClient
registerClient_scopes :: Lens' RegisterClient (Maybe [Text])
registerClient_clientName :: Lens' RegisterClient Text
registerClient_clientType :: Lens' RegisterClient Text
data RegisterClientResponse = RegisterClientResponse' {
- clientId :: Maybe Text
- clientSecret :: Maybe Text
- clientIdIssuedAt :: Maybe Integer
- clientSecretExpiresAt :: Maybe Integer
- tokenEndpoint :: Maybe Text
- authorizationEndpoint :: Maybe Text
- httpStatus :: Int
}
newRegisterClientResponse :: Int -> RegisterClientResponse
registerClientResponse_clientId :: Lens' RegisterClientResponse (Maybe Text)
registerClientResponse_clientSecret :: Lens' RegisterClientResponse (Maybe Text)
registerClientResponse_clientIdIssuedAt :: Lens' RegisterClientResponse (Maybe Integer)
registerClientResponse_clientSecretExpiresAt :: Lens' RegisterClientResponse (Maybe Integer)
registerClientResponse_tokenEndpoint :: Lens' RegisterClientResponse (Maybe Text)
registerClientResponse_authorizationEndpoint :: Lens' RegisterClientResponse (Maybe Text)
registerClientResponse_httpStatus :: Lens' RegisterClientResponse Int

Creating a Request

data RegisterClient Source #

See: newRegisterClient smart constructor.

Constructors

RegisterClient'
Fields scopes :: Maybe [Text] The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token. clientName :: Text The friendly name of the client. clientType :: Text The type of client. The service supports only `public` as a client type. Anything other than public will be rejected by the service.

Instances

Instances details

Eq RegisterClient Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient Methods (==) :: RegisterClient -> RegisterClient -> Bool # (/=) :: RegisterClient -> RegisterClient -> Bool #
Read RegisterClient Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient Methods readsPrec :: Int -> ReadS RegisterClient # readList :: ReadS [RegisterClient] # readPrec :: ReadPrec RegisterClient # readListPrec :: ReadPrec [RegisterClient] #
Show RegisterClient Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient Methods showsPrec :: Int -> RegisterClient -> ShowS # show :: RegisterClient -> String # showList :: [RegisterClient] -> ShowS #
Generic RegisterClient Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient Associated Types type Rep RegisterClient :: Type -> Type # Methods from :: RegisterClient -> Rep RegisterClient x # to :: Rep RegisterClient x -> RegisterClient #
NFData RegisterClient Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient Methods rnf :: RegisterClient -> () #
Hashable RegisterClient Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient Methods hashWithSalt :: Int -> RegisterClient -> Int # hash :: RegisterClient -> Int #
ToJSON RegisterClient Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient Methods toJSON :: RegisterClient -> Value # toEncoding :: RegisterClient -> Encoding # toJSONList :: [RegisterClient] -> Value # toEncodingList :: [RegisterClient] -> Encoding #
AWSRequest RegisterClient Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient Associated Types type AWSResponse RegisterClient # Methods request :: RegisterClient -> Request RegisterClient # response :: MonadResource m => Logger -> Service -> Proxy RegisterClient -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterClient))) #
ToHeaders RegisterClient Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient Methods toHeaders :: RegisterClient -> [Header] #
ToPath RegisterClient Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient Methods toPath :: RegisterClient -> ByteString #
ToQuery RegisterClient Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient Methods toQuery :: RegisterClient -> QueryString #
type Rep RegisterClient Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient type Rep RegisterClient = D1 ('MetaData "RegisterClient" "Amazonka.SSOOIDC.RegisterClient" "libZSservicesZSamazonka-sso-oidcZSamazonka-sso-oidc" 'False) (C1 ('MetaCons "RegisterClient'" 'PrefixI 'True) (S1 ('MetaSel ('Just "scopes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "clientName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "clientType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse RegisterClient Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient type AWSResponse RegisterClient = RegisterClientResponse

newRegisterClient Source #

Arguments

:: Text	`$sel:clientName:RegisterClient'`
-> Text	`$sel:clientType:RegisterClient'`
-> RegisterClient

Create a value of RegisterClient 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:scopes:RegisterClient', registerClient_scopes - The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

$sel:clientName:RegisterClient', registerClient_clientName - The friendly name of the client.

$sel:clientType:RegisterClient', registerClient_clientType - The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service.

Request Lenses

registerClient_scopes :: Lens' RegisterClient (Maybe [Text]) Source #

The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

registerClient_clientName :: Lens' RegisterClient Text Source #

The friendly name of the client.

registerClient_clientType :: Lens' RegisterClient Text Source #

The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service.

Destructuring the Response

data RegisterClientResponse Source #

See: newRegisterClientResponse smart constructor.

Constructors

RegisterClientResponse'

Fields

clientId :: Maybe Text
The unique identifier string for each client. This client uses this identifier to get authenticated by the service in subsequent calls.
clientSecret :: Maybe Text
A secret string generated for the client. The client will use this string to get authenticated by the service in subsequent calls.
clientIdIssuedAt :: Maybe Integer
Indicates the time at which the clientId and clientSecret were issued.
clientSecretExpiresAt :: Maybe Integer
Indicates the time at which the clientId and clientSecret will become invalid.
tokenEndpoint :: Maybe Text
The endpoint where the client can get an access token.
authorizationEndpoint :: Maybe Text
The endpoint where the client can request authorization.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq RegisterClientResponse Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient Methods (==) :: RegisterClientResponse -> RegisterClientResponse -> Bool # (/=) :: RegisterClientResponse -> RegisterClientResponse -> Bool #
Read RegisterClientResponse Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient Methods readsPrec :: Int -> ReadS RegisterClientResponse # readList :: ReadS [RegisterClientResponse] # readPrec :: ReadPrec RegisterClientResponse # readListPrec :: ReadPrec [RegisterClientResponse] #
Show RegisterClientResponse Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient Methods showsPrec :: Int -> RegisterClientResponse -> ShowS # show :: RegisterClientResponse -> String # showList :: [RegisterClientResponse] -> ShowS #
Generic RegisterClientResponse Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient Associated Types type Rep RegisterClientResponse :: Type -> Type # Methods from :: RegisterClientResponse -> Rep RegisterClientResponse x # to :: Rep RegisterClientResponse x -> RegisterClientResponse #
NFData RegisterClientResponse Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient Methods rnf :: RegisterClientResponse -> () #
type Rep RegisterClientResponse Source #
Instance details Defined in Amazonka.SSOOIDC.RegisterClient type Rep RegisterClientResponse = D1 ('MetaData "RegisterClientResponse" "Amazonka.SSOOIDC.RegisterClient" "libZSservicesZSamazonka-sso-oidcZSamazonka-sso-oidc" 'False) (C1 ('MetaCons "RegisterClientResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "clientSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clientIdIssuedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: ((S1 ('MetaSel ('Just "clientSecretExpiresAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "tokenEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "authorizationEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newRegisterClientResponse Source #

Arguments

:: Int	`$sel:httpStatus:RegisterClientResponse'`
-> RegisterClientResponse

Create a value of RegisterClientResponse 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:clientId:RegisterClientResponse', registerClientResponse_clientId - The unique identifier string for each client. This client uses this identifier to get authenticated by the service in subsequent calls.

$sel:clientSecret:RegisterClientResponse', registerClientResponse_clientSecret - A secret string generated for the client. The client will use this string to get authenticated by the service in subsequent calls.

$sel:clientIdIssuedAt:RegisterClientResponse', registerClientResponse_clientIdIssuedAt - Indicates the time at which the clientId and clientSecret were issued.

$sel:clientSecretExpiresAt:RegisterClientResponse', registerClientResponse_clientSecretExpiresAt - Indicates the time at which the clientId and clientSecret will become invalid.

$sel:tokenEndpoint:RegisterClientResponse', registerClientResponse_tokenEndpoint - The endpoint where the client can get an access token.

$sel:authorizationEndpoint:RegisterClientResponse', registerClientResponse_authorizationEndpoint - The endpoint where the client can request authorization.

$sel:httpStatus:RegisterClientResponse', registerClientResponse_httpStatus - The response's http status code.

Response Lenses

registerClientResponse_clientId :: Lens' RegisterClientResponse (Maybe Text) Source #

The unique identifier string for each client. This client uses this identifier to get authenticated by the service in subsequent calls.

registerClientResponse_clientSecret :: Lens' RegisterClientResponse (Maybe Text) Source #

A secret string generated for the client. The client will use this string to get authenticated by the service in subsequent calls.

registerClientResponse_clientIdIssuedAt :: Lens' RegisterClientResponse (Maybe Integer) Source #

Indicates the time at which the clientId and clientSecret were issued.

registerClientResponse_clientSecretExpiresAt :: Lens' RegisterClientResponse (Maybe Integer) Source #

Indicates the time at which the clientId and clientSecret will become invalid.

registerClientResponse_tokenEndpoint :: Lens' RegisterClientResponse (Maybe Text) Source #

The endpoint where the client can get an access token.

registerClientResponse_authorizationEndpoint :: Lens' RegisterClientResponse (Maybe Text) Source #

The endpoint where the client can request authorization.

registerClientResponse_httpStatus :: Lens' RegisterClientResponse Int Source #

The response's http status code.