Skip to content

Register Client

ssooidc_register_client R Documentation

Registers a client with IAM Identity Center

Description

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.

Usage

ssooidc_register_client(clientName, clientType, scopes, redirectUris,
  grantTypes, issuerUrl, entitledApplicationArn)

Arguments

clientName

[required] The friendly name of the client.

clientType

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

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.

redirectUris

The list of redirect URI that are defined by the client. At completion of authorization, this list is used to restrict what locations the user agent can be redirected back to.

grantTypes

The list of OAuth 2.0 grant types that are defined by the client. This list is used to restrict the token granting flows available to the client.

issuerUrl

The IAM Identity Center Issuer URL associated with an instance of IAM Identity Center. This value is needed for user access to resources through the client.

entitledApplicationArn

This IAM Identity Center application ARN is used to define administrator-managed configuration for public client access to resources. At authorization, the scopes, grants, and redirect URI available to this client will be restricted by this application resource.

Value

A list with the following syntax: 

list(
  clientId = "string",
  clientSecret = "string",
  clientIdIssuedAt = 123,
  clientSecretExpiresAt = 123,
  authorizationEndpoint = "string",
  tokenEndpoint = "string"
)

Request syntax

svc$register_client(
  clientName = "string",
  clientType = "string",
  scopes = list(
    "string"
  ),
  redirectUris = list(
    "string"
  ),
  grantTypes = list(
    "string"
  ),
  issuerUrl = "string",
  entitledApplicationArn = "string"
)

Examples

## Not run: 
# 
svc$register_client(
  clientName = "My IDE Plugin",
  clientType = "public",
  entitledApplicationArn = "arn:aws:sso::ACCOUNTID:application/ssoins-11111...",
  grantTypes = list(
    "authorization_code",
    "refresh_token"
  ),
  issuerUrl = "https://identitycenter.amazonaws.com/ssoins-1111111111111111",
  redirectUris = list(
    "127.0.0.1:PORT/oauth/callback"
  ),
  scopes = list(
    "sso:account:access",
    "codewhisperer:completions"
  )
)

## End(Not run)