Skip to main content

Patch Personal Access Token​

This performs a targeted update to the field(s) of a Personal Access Token.

Path Parameters
  • id string required

    The Personal Access Token id

    Example: ef38f94347e94562b5bb8424a56397d8
Request Body array required

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

The following fields are patchable:

  • name
  • scope
  • op string required

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

    The operation to be performed

  • path string required

    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

    anyOf

  • string
Responses

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


Schema
  • id string

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

  • name string

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

  • scope string[]

    Scopes of the personal access token.

  • owner object

    Details about the owner of the personal access token.

  • type string

    Possible values: [ACCOUNT_CORRELATION_CONFIG, ACCESS_PROFILE, ACCESS_REQUEST_APPROVAL, ACCOUNT, APPLICATION, CAMPAIGN, CAMPAIGN_FILTER, CERTIFICATION, CLUSTER, CONNECTOR_SCHEMA, ENTITLEMENT, GOVERNANCE_GROUP, IDENTITY, IDENTITY_PROFILE, IDENTITY_REQUEST, LIFECYCLE_STATE, PASSWORD_POLICY, ROLE, RULE, SOD_POLICY, SOURCE, TAG_CATEGORY, TASK_RESULT, REPORT_RESULT, SOD_VIOLATION, ACCOUNT_ACTIVITY]

    DTO type

  • id string

    ID of the object to which this reference applies

  • name string

    Human-readable display name of the object to which this reference applies

  • created date-time

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

  • lastUsed date-time

    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.

Loading...