Entity Authentication Token

Get Authentication Token

Get the authentication token for a user in a specific entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/authentication-token

Path parameters

entityId*string

The ID of the entity.

userId*string

The ID of the user.

Header parameters

Response

200400404500

Successful operation

Body

application/json

successboolean

authenticationTokenstring

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/authentication-token', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": true,
  "authenticationToken": "text"
}

Create Authentication Token

Create an authentication token for a user in a specific entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/authentication-token

Path parameters

entityId*string

The ID of the entity.

userId*string

The ID of the user.

Header parameters

Response

201400500

Successful operation

Body

application/json

successboolean

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/authentication-token', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": true
}

Delete Authentication Token

Delete the authentication token for a user in a specific entity.

DELETEhttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/authentication-token

Path parameters

entityId*string

The ID of the entity.

userId*string

The ID of the user.

Header parameters

Response

200400500

Successful operation

Body

application/json

successboolean

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/authentication-token', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "success": true
}

Update Authentication Token

Update the authentication token for a user in a specific entity.

PATCHhttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/authentication-token

Path parameters

entityId*string

The ID of the entity.

userId*string

The ID of the user.

Header parameters

Body

application/json

The details to update the authentication token.

expirystring (date-time)

The new expiry date for the token.

flagsarray of string

Any new flags for the token.

Response

200400500

Successful operation

Body

application/json

successboolean

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/authentication-token', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "expiry": "2023-12-31T23:59:59Z",
      "flags": [
        "new_flag_1",
        "new_flag_2"
      ]
    }),
});
const data = await response.json();

Response

{
  "success": true
}

Refresh Authentication Token

Refresh the authentication token for a user in a specific entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/authentication-token/refresh

Path parameters

entityId*string

The ID of the entity.

userId*string

The ID of the user.

Header parameters

Body

application/json

The details to refresh the authentication token.

authenticationTokenstring

The current authentication token to refresh.

Response

200400500

Successful operation

Body

application/json

successboolean

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/authentication-token/refresh', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "authenticationToken": "current_token_value"
    }),
});
const data = await response.json();

Response

{
  "success": true
}