Entity Authentication Token

Quest Protocol

Get Authentication Token

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

get

/entities/{entityId}/users/{userId}/authentication-token

Path parameters

entityIdstringrequired

The ID of the entity.

userIdstringrequired

The ID of the user.

Header parameters

apikeystringrequired

The API key for authentication

Example: test

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/authentication-token' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

404

500

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

Successful operation

Create Authentication Token

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

post

/entities/{entityId}/users/{userId}/authentication-token

Path parameters

entityIdstringrequired

The ID of the entity.

userIdstringrequired

The ID of the user.

Header parameters

apikeystringrequired

The API key for authentication

Example: test

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/authentication-token' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

201

400

500

{
  "success": true
}

Successful operation

Delete Authentication Token

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

delete

/entities/{entityId}/users/{userId}/authentication-token

Path parameters

entityIdstringrequired

The ID of the entity.

userIdstringrequired

The ID of the user.

Header parameters

apikeystringrequired

The API key for authentication

Example: test

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/authentication-token' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

500

{
  "success": true
}

Successful operation

Update Authentication Token

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

patch

/entities/{entityId}/users/{userId}/authentication-token

Path parameters

entityIdstringrequired

The ID of the entity.

userIdstringrequired

The ID of the user.

Header parameters

apikeystringrequired

The API key for authentication

Example: test

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

expirystring · date-time

The new expiry date for the token.

flagsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/authentication-token' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "expiry": "2023-12-31T23:59:59Z",
    "flags": [
      "new_flag_1",
      "new_flag_2"
    ]
  }'

200

400

500

{
  "success": true
}

Successful operation

Refresh Authentication Token

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

post

/entities/{entityId}/users/{userId}/authentication-token/refresh

Path parameters

entityIdstringrequired

The ID of the entity.

userIdstringrequired

The ID of the user.

Header parameters

apikeystringrequired

The API key for authentication

Example: test

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

authenticationTokenstring

The current authentication token to refresh.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/authentication-token/refresh' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "authenticationToken": "current_token_value"
  }'

200

400

500

{
  "success": true
}

Successful operation