ListAccounts
Lists all Amazon accounts assigned to the user. These Amazon accounts are assigned by the
administrator of the account. For more information, see Assign User Access
Request Syntax
GET /assignment/accounts?max_result=maxResults
&next_token=nextToken
HTTP/1.1
x-amz-sso_bearer_token: accessToken
URI Request Parameters
The request uses the following URI parameters.
- accessToken
-
The token issued by the
CreateToken
API call. For more information, see CreateTokenin the IAM Identity Center OIDC API Reference Guide. Required: Yes
- maxResults
-
This is the number of items clients can request per page.
Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
(Optional) When requesting subsequent pages, this is the page token from the previous response output.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"accountList": [
{
"accountId": "string",
"accountName": "string",
"emailAddress": "string"
}
],
"nextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- accountList
-
A paginated response with the list of account information and the next token if more results are available.
Type: Array of AccountInfo objects
- nextToken
-
The page token client that is used to retrieve the list of accounts.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidRequestException
-
Indicates that a problem occurred with the input to the request. For example, a required parameter might be missing or out of range.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource doesn't exist.
HTTP Status Code: 404
- TooManyRequestsException
-
Indicates that the request is being made too frequently and is more than what the server can handle.
HTTP Status Code: 429
- UnauthorizedException
-
Indicates that the request is not authorized. This can happen due to an invalid access token in the request.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: