Skip to content

Start Device Authorization

ssooidc_start_device_authorization R Documentation

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

Description

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

Usage

ssooidc_start_device_authorization(clientId, clientSecret, startUrl)

Arguments

clientId

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

clientSecret

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

startUrl

[required] The URL for the Amazon Web Services access portal. For more information, see Using the Amazon Web Services access portal in the IAM Identity Center User Guide.

Value

A list with the following syntax:

list(
  deviceCode = "string",
  userCode = "string",
  verificationUri = "string",
  verificationUriComplete = "string",
  expiresIn = 123,
  interval = 123
)

Request syntax

svc$start_device_authorization(
  clientId = "string",
  clientSecret = "string",
  startUrl = "string"
)

Examples

## Not run: 
# 
svc$start_device_authorization(
  clientId = "_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID",
  clientSecret = "VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0",
  startUrl = "https://identitycenter.amazonaws.com/ssoins-111111111111"
)

## End(Not run)