Personal access tokens

Generate a personal access token in the CloudBees platform and use it for authentication in external tools. In an external tool, such as an IDE, call an API with this token to trigger a manual workflow in the platform.

Because your personal access token is used like a password for authentication, use best practices when storing it in external tools.

Access PATs

Your list of tokens remains constant regardless of which platform organization you are using.

To access your tokens:

Select your account name, and then select User profile.
Select the Personal access tokens tab.

Your personal access tokens are listed with their duration and expiration date.

Generate a personal access token

The CloudBees platform personal access token is only for authentication for remote workflow execution; it cannot be used for other tasks.

To generate a token:

Select your account name and then select User profile.
Select the Personal access tokens tab.
Select Generate token.
Enter a token Name.
(Optional) Enter a Description.
Enter a Duration (how long the token remains valid) from the following options:
- Keep the default duration of 7 days.
- Select a 30, 60, or 90 day duration.
- Select Custom and enter a custom duration:
  1. Select .
  2. (Optional) Select to go to a future month and year.
  3. (Optional) Select and to move from month to month.
  4. Select a date on the calendar for the duration end.
Select Generate to display the personal access token.
Select to copy the personal access token and paste it in a safe location.
Copy the curl command to refer back to when you call the API. Refer to Trigger a workflow remotely for more information.

Figure 1. Example generated PAT with Copy highlighted.

The personal access token is generated to authenticate you to remotely invoke a manual workflow.

Delete a personal access token

Delete any of your personal access tokens. A deleted token is completely removed from the CloudBees platform and the deletion is irreversible.

To delete a personal access token:

Select your account name and then select User profile.
Select the Personal access tokens tab.
Select next to the personal access token you want to delete.
Select Delete.
Select Delete.

The selected token is deleted and removed from the tokens list.