This is an archive version of the document. To get the most up-to-date information, see the current version.Revoke Authentication Token
You can revoke access token for a specific user or user identity.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To revoke access token, send the DELETE HTTP request to the URL of the /users/{userId}/tokens resource. If you want to log out a specific user identity, you must also create a query string that contains ID of this user identity.
HTTP Request
DELETE https://<hostname>:1280/api/v3/users/{userId}/tokens?userLoginId={userLoginId} |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|---|
userId | Path | String (uuid) | Yes | — | — | User UID |
userLoginId | Query | Integer (int64) | No | — | — | User identity ID |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns the true value if the operation is successful.
Example 
The following request revokes access token from the user identity with ID 1.
Request: DELETE https://<hostname>:1280/api/v3/users/49f5c6eb-c0c8-4fc2-89ee-927107c7a40c/tokens?userLoginId=1
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": true } |