Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListPersonalAccessTokens

Important

End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.

Returns a summary of your Personal Access Tokens.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "OrganizationId": "string",
   "UserId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

The maximum amount of items that should be returned in a response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The token from the previous response to query the next page.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024}

Required: No

OrganizationId

The Organization ID.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

UserId

The WorkMail User ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9._%+@-]+

Required: No

Response Syntax


{
   "NextToken": "string",
   "PersonalAccessTokenSummaries": [ 
      { 
         "DateCreated": number,
         "DateLastUsed": number,
         "ExpiresTime": number,
         "Name": "string",
         "PersonalAccessTokenId": "string",
         "Scopes": [ "string" ],
         "UserId": "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.

NextToken

The token from the previous response to query the next page.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024}

PersonalAccessTokenSummaries

Lists all the personal tokens in an organization or user, if user ID is provided.

Type: Array of PersonalAccessTokenSummary objects

Errors

For information about the errors that are common to all actions, see Common Error Types.

EntityNotFoundException

Important

The identifier supplied for the user, group, or resource does not exist in your organization.

HTTP Status Code: 400

EntityStateException

Important

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

HTTP Status Code: 400

InvalidParameterException

Important

One or more of the input parameters don't match the service's restrictions.

HTTP Status Code: 400

OrganizationNotFoundException

Important

An operation received a valid organization identifier that either doesn't belong or exist in the system.

HTTP Status Code: 400

OrganizationStateException

Important

The organization must have a valid state to perform certain operations on the organization or its members.

HTTP Status Code: 400