WorkMail / Client / list_personal_access_tokens

list_personal_access_tokens¶

WorkMail.Client.list_personal_access_tokens(**kwargs)¶

Returns a summary of your Personal Access Tokens.

Request Syntax

response = client.list_personal_access_tokens(
    OrganizationId='string',
    UserId='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

OrganizationId (string) –
[REQUIRED]

The Organization ID.
UserId (string) – The WorkMail User ID.
NextToken (string) – The token from the previous response to query the next page.
MaxResults (integer) – The maximum amount of items that should be returned in a response.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'PersonalAccessTokenSummaries': [
        {
            'PersonalAccessTokenId': 'string',
            'UserId': 'string',
            'Name': 'string',
            'DateCreated': datetime(2015, 1, 1),
            'DateLastUsed': datetime(2015, 1, 1),
            'ExpiresTime': datetime(2015, 1, 1),
            'Scopes': [
                'string',
            ]
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  The token from the previous response to query the next page.
- PersonalAccessTokenSummaries (list) –
  
  Lists all the personal tokens in an organization or user, if user ID is provided.
  - (dict) –
    
    The summary of the Personal Access Token.
    - PersonalAccessTokenId (string) –
      
      The ID of the Personal Access Token.
    - UserId (string) –
      
      The user ID of the WorkMail user associated with the Personal Access Token.
    - Name (string) –
      
      The name of the Personal Access Token.
    - DateCreated (datetime) –
      
      The date when the Personal Access Token was created.
    - DateLastUsed (datetime) –
      
      The date when the Personal Access Token was last used.
    - ExpiresTime (datetime) –
      
      The date when the Personal Access Token will expire.
    - Scopes (list) –
      
      Lists all the Personal Access Token permissions for a mailbox.
      - (string) –

Exceptions

WorkMail.Client.exceptions.InvalidParameterException
WorkMail.Client.exceptions.EntityNotFoundException
WorkMail.Client.exceptions.EntityStateException
WorkMail.Client.exceptions.OrganizationNotFoundException
WorkMail.Client.exceptions.OrganizationStateException