ISSOOIDCRegisterClientRequest

Interface in AWS.SSOOIDC

Interface for RegisterClient requests.

Ancestors

• ISSOOIDCRequest

Properties

clientName

property clientName: string

Specify the friendly name of the client.

clientType

property clientType: string

Specify the type of the client.

The service only supports public as a client type.

entitledApplicationArn

property entitledApplicationArn: TARN

Specify the IAM Identity Center application Amazon Resource Name (ARN) used to define administrator-managed configuration for public client access to resources.

grantTypes

property grantTypes: TList<string>

Optionally, specify a list of OAuth 2.0 grant types.

This list is used to restrict the token granting flows available to the client. Supports grant types:

• authorization_code
• refresh_token
• device code For device code requests, specify the value: urn:ietf:params:oauth:grant-type:device_code.

issuerUrl

property issuerUrl: string

Optionally, specify the IAM Identity Center Issuer URL associated with an instance of IAM Identity Center.

This value is required for user access to resources through the client.

redirectUris

property redirectUris: TList<string>

Optionally, specify a list of redirect URI that are defined by the client.

scope

property scope: TList<string>

Specify a list of scope that is defined by the client.

Upon authorization, this list is used to restrict permissions when granting an access token.

Methods

AddGrantType

function AddGrantType(const AGrantType: string): NativeInt;

Add an OAuth 2.0 grant type to grantTypes.

Parameters

Name	Description
AGrantType	Specify an OAuth 2.0 grant type. Valid values:||.

Returns

Returns the index of the grant type added to grantTypes.

AddRedirectUri

function AddRedirectUri(const ARedirectUri: string): NativeInt;

Add a URI to redirectUris.

Parameters

Name	Description
ARedirectUri	Specify a URI to add to redirectUris.

Returns

Returns the index of the URI added to redirectUris.

AddScope

function AddScope(const AScope: string): NativeInt;

Add scope to scope.

Parameters

Name	Description
AScope	Specify a scope defined by the client.

Returns

Returns the index of the scope added to scope.