API reference

User management

Activate a user

User Management API (v2)

Download OpenAPI description

UsersApi.json

UsersApi.yaml

Servers

Staging URL

https://apis.spotnana.com/

Spotnana mock server

https://developer.spotnana.com/_mock/openapi/usersapi/

Users

APIs to onboard and manage users.

Operations

Update user's external ID

Request

This endpoint updates user's external ID by user ID.

Path

userIdstring(uuid)required

Identifier for user.

Example: 4974a66b-7493-4f41-908c-58ba81093947

Query

includeInactiveboolean

Include inactive users.

Default false

Example: includeInactive=true

Bodyapplication/jsonrequired

externalIdstringrequired

A partner-assigned user identifier. This value must be unique for all travelers within a PNR.

Example: "user-1"

curl -i -X PUT \
  'https://apis.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/external-id?includeInactive=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "externalId": "user-1"
  }'

Responses

Response

No content

Activate a user

Request

This endpoint activates a deactivated user.

Path

userIdstring(uuid)required

Identifier for user.

Example: 4974a66b-7493-4f41-908c-58ba81093947

curl -i -X POST \
  https://apis.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/activate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response

No content

Get user policies

Request

Path

userIdstring(uuid)required

Identifier for user.

Example: 4974a66b-7493-4f41-908c-58ba81093947

curl -i -X GET \
  https://apis.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/applicable-policies \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

policiesArray of objects(PolicyBasicInfo)

Response

application/json

{
  "policies": [
    { … }
  ]
}