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.SSOOIDC.StartDeviceAuthorization

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Initiates device authorization by requesting a pair of verification codes from the authorization service.

Synopsis

Creating a Request

data StartDeviceAuthorization Source #

See: newStartDeviceAuthorization smart constructor.

Constructors

StartDeviceAuthorization'

Fields

clientId :: Text
The unique identifier string for the client that is registered with IAM Identity Center. This value should come from the persisted result of the RegisterClient API operation.
clientSecret :: Text
A secret string that is generated for the client. This value should come from the persisted result of the RegisterClient API operation.
startUrl :: Text
The URL for the AWS access portal. For more information, see Using the AWS access portal in the IAM Identity Center User Guide.

Instances

Instances details

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

newStartDeviceAuthorization Source #

Arguments

:: Text	`$sel:clientId:StartDeviceAuthorization'`
-> Text	`$sel:clientSecret:StartDeviceAuthorization'`
-> Text	`$sel:startUrl:StartDeviceAuthorization'`
-> StartDeviceAuthorization

Create a value of StartDeviceAuthorization 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:StartDeviceAuthorization', startDeviceAuthorization_clientId - The unique identifier string for the client that is registered with IAM Identity Center. This value should come from the persisted result of the RegisterClient API operation.

$sel:clientSecret:StartDeviceAuthorization', startDeviceAuthorization_clientSecret - A secret string that is generated for the client. This value should come from the persisted result of the RegisterClient API operation.

$sel:startUrl:StartDeviceAuthorization', startDeviceAuthorization_startUrl - The URL for the AWS access portal. For more information, see Using the AWS access portal in the IAM Identity Center User Guide.

Request Lenses

startDeviceAuthorization_clientId :: Lens' StartDeviceAuthorization Text Source #

The unique identifier string for the client that is registered with IAM Identity Center. This value should come from the persisted result of the RegisterClient API operation.

startDeviceAuthorization_clientSecret :: Lens' StartDeviceAuthorization Text Source #

A secret string that is generated for the client. This value should come from the persisted result of the RegisterClient API operation.

startDeviceAuthorization_startUrl :: Lens' StartDeviceAuthorization Text Source #

The URL for the AWS access portal. For more information, see Using the AWS access portal in the IAM Identity Center User Guide.

Destructuring the Response

data StartDeviceAuthorizationResponse Source #

See: newStartDeviceAuthorizationResponse smart constructor.

Constructors

StartDeviceAuthorizationResponse'

Fields

deviceCode :: Maybe Text
The short-lived code that is used by the device when polling for a session token.
expiresIn :: Maybe Int
Indicates the number of seconds in which the verification code will become invalid.
interval :: Maybe Int
Indicates the number of seconds the client must wait between attempts when polling for a session.
userCode :: Maybe Text
A one-time user verification code. This is needed to authorize an in-use device.
verificationUri :: Maybe Text
The URI of the verification page that takes the userCode to authorize the device.
verificationUriComplete :: Maybe Text
An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic StartDeviceAuthorizationResponse Source #
Instance details Defined in Amazonka.SSOOIDC.StartDeviceAuthorization Associated Types type Rep StartDeviceAuthorizationResponse :: Type -> Type # Methods from :: StartDeviceAuthorizationResponse -> Rep StartDeviceAuthorizationResponse x # to :: Rep StartDeviceAuthorizationResponse x -> StartDeviceAuthorizationResponse #
Read StartDeviceAuthorizationResponse Source #
Instance details Defined in Amazonka.SSOOIDC.StartDeviceAuthorization Methods readsPrec :: Int -> ReadS StartDeviceAuthorizationResponse # readList :: ReadS [StartDeviceAuthorizationResponse] # readPrec :: ReadPrec StartDeviceAuthorizationResponse # readListPrec :: ReadPrec [StartDeviceAuthorizationResponse] #
Show StartDeviceAuthorizationResponse Source #
Instance details Defined in Amazonka.SSOOIDC.StartDeviceAuthorization Methods showsPrec :: Int -> StartDeviceAuthorizationResponse -> ShowS # show :: StartDeviceAuthorizationResponse -> String # showList :: [StartDeviceAuthorizationResponse] -> ShowS #
NFData StartDeviceAuthorizationResponse Source #
Instance details Defined in Amazonka.SSOOIDC.StartDeviceAuthorization Methods rnf :: StartDeviceAuthorizationResponse -> () #
Eq StartDeviceAuthorizationResponse Source #
Instance details Defined in Amazonka.SSOOIDC.StartDeviceAuthorization Methods (==) :: StartDeviceAuthorizationResponse -> StartDeviceAuthorizationResponse -> Bool # (/=) :: StartDeviceAuthorizationResponse -> StartDeviceAuthorizationResponse -> Bool #
type Rep StartDeviceAuthorizationResponse Source #
Instance details Defined in Amazonka.SSOOIDC.StartDeviceAuthorization type Rep StartDeviceAuthorizationResponse = D1 ('MetaData "StartDeviceAuthorizationResponse" "Amazonka.SSOOIDC.StartDeviceAuthorization" "amazonka-sso-oidc-2.0-3eSk2Q0gyQnBlHT8MIKfRj" 'False) (C1 ('MetaCons "StartDeviceAuthorizationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deviceCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "expiresIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "interval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "userCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "verificationUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "verificationUriComplete") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newStartDeviceAuthorizationResponse Source #

Arguments

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

Create a value of StartDeviceAuthorizationResponse 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:deviceCode:StartDeviceAuthorizationResponse', startDeviceAuthorizationResponse_deviceCode - The short-lived code that is used by the device when polling for a session token.

$sel:expiresIn:StartDeviceAuthorizationResponse', startDeviceAuthorizationResponse_expiresIn - Indicates the number of seconds in which the verification code will become invalid.

$sel:interval:StartDeviceAuthorizationResponse', startDeviceAuthorizationResponse_interval - Indicates the number of seconds the client must wait between attempts when polling for a session.

$sel:userCode:StartDeviceAuthorizationResponse', startDeviceAuthorizationResponse_userCode - A one-time user verification code. This is needed to authorize an in-use device.

$sel:verificationUri:StartDeviceAuthorizationResponse', startDeviceAuthorizationResponse_verificationUri - The URI of the verification page that takes the userCode to authorize the device.

$sel:verificationUriComplete:StartDeviceAuthorizationResponse', startDeviceAuthorizationResponse_verificationUriComplete - An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.

$sel:httpStatus:StartDeviceAuthorizationResponse', startDeviceAuthorizationResponse_httpStatus - The response's http status code.

Response Lenses

startDeviceAuthorizationResponse_deviceCode :: Lens' StartDeviceAuthorizationResponse (Maybe Text) Source #

The short-lived code that is used by the device when polling for a session token.

startDeviceAuthorizationResponse_expiresIn :: Lens' StartDeviceAuthorizationResponse (Maybe Int) Source #

Indicates the number of seconds in which the verification code will become invalid.

startDeviceAuthorizationResponse_interval :: Lens' StartDeviceAuthorizationResponse (Maybe Int) Source #

Indicates the number of seconds the client must wait between attempts when polling for a session.

startDeviceAuthorizationResponse_userCode :: Lens' StartDeviceAuthorizationResponse (Maybe Text) Source #

A one-time user verification code. This is needed to authorize an in-use device.

startDeviceAuthorizationResponse_verificationUri :: Lens' StartDeviceAuthorizationResponse (Maybe Text) Source #

The URI of the verification page that takes the userCode to authorize the device.

startDeviceAuthorizationResponse_verificationUriComplete :: Lens' StartDeviceAuthorizationResponse (Maybe Text) Source #

An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.

startDeviceAuthorizationResponse_httpStatus :: Lens' StartDeviceAuthorizationResponse Int Source #

The response's http status code.