Personal Access Key

A Personal Access Key is a secure credential used for obtaining a Personal Access Token (PAT) which is used for authentication when using Appcircle’s APIs. It inherits the permissions of your user account within the organization and is organization-specific—meaning you must generate a separate Personal Access Key for each organization you access.

Personal API Token Renamed

The Personal Access Key was previously referred to as the Personal API Token. Only the name has changed, and all functionality remains the same.

Generating/Managing the Personal Access Keys

To generate a Personal Access Key, go to the My Organization screen in the Appcircle dashboard. After that, find the Security section from the left side menu. The Personal Access Key section is located on the bottom right.

Press the "Generate Key" button to generate your first key.

The key will then be generated and displayed above the button. Please make sure that you save the key before navigating away from the page as it will be displayed only once for security reasons.

If you want to delete a previously generated key, press "Delete Key" and confirm. You can then generate a new access key if you would like.

Personal Access Key for Sub-Organizations

To generate a Personal Access Key for a sub-organization, you must be added as a member of that sub-organization. Users inherited from a parent organization cannot generate a Personal Access Key. For additional details on Organization and Team management, refer to the relevant documentation.

info

Personal Access Keys are only accessible within the organization where they were generated. However, a Personal Access Key created in the Root organization can also be used for sub-organizations.

You can pass the subOrganization parameter when obtaining a Personal Access Token(PAT) using a Root Personal Access Key.

curl -X 'POST' \
  'https://auth.appcircle.io/auth/v3/token' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'personalAccessKey=your_access_key' \
  -d 'scope=openid,profile,email'
  -d 'subOrganization={orgId}"

Please ensure that the endpoint you are using is v2.

Personal API Token Renamed

The Personal Access Key was previously referred to as the Personal API Token. The old endpoint is still available, but it is recommended to migrate to the new version. For reference, the old endpoint was:

curl -X 'POST' \
  'https://auth.appcircle.io/auth/v2/token' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'pat=$pat' \
  -d 'scope=openid,profile,email'
  -d 'subOrganization={orgId}"

Generating/Managing the Personal Access Keys​

Generating/Managing the Personal Access Keys