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 |
Registers a client with IAM Identity Center. 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' {}
- newRegisterClientResponse :: Int -> RegisterClientResponse
- registerClientResponse_authorizationEndpoint :: Lens' RegisterClientResponse (Maybe Text)
- registerClientResponse_clientId :: Lens' RegisterClientResponse (Maybe Text)
- registerClientResponse_clientIdIssuedAt :: Lens' RegisterClientResponse (Maybe Integer)
- registerClientResponse_clientSecret :: Lens' RegisterClientResponse (Maybe Text)
- registerClientResponse_clientSecretExpiresAt :: Lens' RegisterClientResponse (Maybe Integer)
- registerClientResponse_tokenEndpoint :: Lens' RegisterClientResponse (Maybe Text)
- registerClientResponse_httpStatus :: Lens' RegisterClientResponse Int
Creating a Request
data RegisterClient Source #
See: newRegisterClient
smart constructor.
RegisterClient' | |
|
Instances
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.
RegisterClientResponse' | |
|
Instances
newRegisterClientResponse Source #
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:authorizationEndpoint:RegisterClientResponse'
, registerClientResponse_authorizationEndpoint
- The endpoint where the client can request authorization.
$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:clientIdIssuedAt:RegisterClientResponse'
, registerClientResponse_clientIdIssuedAt
- Indicates the time at which the clientId
and clientSecret
were
issued.
$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: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:httpStatus:RegisterClientResponse'
, registerClientResponse_httpStatus
- The response's http status code.
Response Lenses
registerClientResponse_authorizationEndpoint :: Lens' RegisterClientResponse (Maybe Text) Source #
The endpoint where the client can request authorization.
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_clientIdIssuedAt :: Lens' RegisterClientResponse (Maybe Integer) Source #
Indicates the time at which the clientId
and clientSecret
were
issued.
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_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_httpStatus :: Lens' RegisterClientResponse Int Source #
The response's http status code.