Access Tokens

Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: Access Tokens | Zephyr Enterprise Documentation

Get a user token

Use the following operation to get a user token in Zephyr Enterprise:

GET /flex/services/rest/v3/usertoken/

Request format

To get a user token, send a GET request to the following URL:

http://{ZEPHYR-SERVER}/flex/services/rest/v3/usertoken/

Sample response

[ { "id": 1, "label": "new", "createdBy": 5 } ]

Create a user token

Use the following operation to create a user token in Zephyr Enterprise:

POST /flex/services/rest/v3/usertoken/

Request format

To create a user token, send a POST request to the following URL:

http://{ZEPHYR-SERVER}/flex/services/rest/v3/usertoken/

Request body

{ "label":"Token" }

Sample response

{ "id": 1, "label": "Token", "token": "b9364433bc252f152cbc72246b9d3d477b0ca4df", "createdBy": "test.manager" }

Delete a user token

Use the following operation:

DELETE /flex/services/rest/v3/usertoken/{id}

{id} - the ID of the user token to be deleted.

Request format

To delete a user token, send a DELETE request to the following URL:

http://{ZEPHYR-SERVER}/flex/services/rest/v3/usertoken/{id}

Response

Delete all user tokens

Use the following operation to delete all user tokens:

DELETE /flex/services/rest/v3/usertoken/all

Request format

To delete all user tokens, send a DELETE request to the following URL:

http://{ZEPHYR-SERVER}/flex/services/rest/v3/usertoken/all

Response

See Also

Migration REST API

Â