Skip to main content

Patch Personal Access Token

PATCH 

/personal-access-tokens/:id

This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens.

Request

Path Parameters

    id stringrequired

    The Personal Access Token id

    Example: ef38f94347e94562b5bb8424a56397d8

Body

array

required

A list of OAuth client update operations according to the JSON Patch standard.

The following fields are patchable:

  • name

  • scope

  • Array [

  • op stringrequired

    Possible values: [add, remove, replace, move, copy, test]

    The operation to be performed

    path stringrequired

    A string JSON Pointer representing the target path to an element to be affected by the operation

    value

    object

    The value to be used for the operation, required for "add" and "replace" operations

    oneOf

    string

  • ]

Responses

Indicates the PATCH operation succeeded, and returns the PAT's new representation.

Schema

    id stringrequired

    The ID of the personal access token (to be used as the username for Basic Auth).

    name stringrequired

    The name of the personal access token. Cannot be the same as other personal access tokens owned by a user.

    scope string[]nullablerequired

    Scopes of the personal access token.

    owner

    object

    required

    Personal access token owner's identity.

    type string

    Possible values: [IDENTITY]

    Personal access token owner's DTO type.

    id string

    Personal access token owner's identity ID.

    name string

    Personal access token owner's human-readable display name.

    created date-timerequired

    The date and time, down to the millisecond, when this personal access token was created.

    lastUsed date-timenullable

    The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed.

    managed boolean

    If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows.

Loading...