The API Token used to authenticate the current user. This token is required for API access and is unique to the user.

Data Type

string

Default Value

""

Remarks

API Tokens grant access to a range of services associated with the user's Atlassian account.

To generate an API token, log in to your Atlassian account, click the user icon in the top-right corner of the page, and navigate to Account settings > Security > API tokens > Create and manage API tokens, then click Create API token. Store this token for later use. Note that the token is shown only once. If you leave the page without copying the token, you will have to create another token and copy its value.

When connecting to a Cloud instance, the driver automatically routes requests through the OAuth-compatible Atlassian endpoint. This enables support for scoped API tokens, allowing you to restrict access to specific Atlassian API scopes. To limit the permissions granted to the driver, set the Scope property to a space-separated list of the desired scopes. For more information, see Scope.

Since the API Token is a sensitive piece of data, it should be handled securely, and it must not be exposed in public or shared in insecure environments.