Get current user details

GET 
/users/current

This endpoint returns details for the currently authenticated user. If the API token used to authenticate to the API is not associated with a user, this method will return an error.

Request

Responses

200

This endpoint returns details for the currently authenticated user. If the API token used to authenticate to the API is not associated with a user, this method will return an error.

application/json

Schema

Schema

user

object

required

id string

first_name string

last_name string

avatar_url string

organizations

object[]

required

Array [

id string

name string

sub_domain string

]

api_token_id stringnullablerequired

Example (from schema)

{
  "user": {
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "avatar_url": "string"
  },
  "organizations": [
    {
      "id": "string",
      "name": "string",
      "sub_domain": "string"
    }
  ],
  "api_token_id": "string"
}

400

No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer

application/json

Schema

Schema

code MissingAPITokenEnum (string)

Possible values: [missing_api_token]

description string
detail object

Example (from schema)

{
  "code": "missing_api_token",
  "description": "string",
  "detail": {}
}

403

403 error response

application/json

Schema

Schema

oneOf

UnauthorizedNetworkForAPITokenSchema

Network is not allowed to access the API with this API token

code UnauthorizedNetworkForAPITokenEnum (string)

Possible values: [unauthorized_network_for_api_token]

description string

detail

object

ip_address string

The IP address the request was received from

InvalidAPITokenSchema

The API token provided was not valid (it may not exist or have expired)

code InvalidAPITokenEnum (string)

Possible values: [invalid_api_token]

description string

detail

object

details stringnullable

InvalidCapabilitiesTokenSchema

The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)

code InvalidCapabilitiesTokenEnum (string)

Possible values: [invalid_capabilities_token]

description string

detail object

ScopeNotGrantedErrorSchema

The scope required for this endpoint has not been granted to the authenticating identity

code ScopeNotGrantedErrorEnum (string)

Possible values: [scope_not_granted]

description string

detail

ScopeNotGrantedError

scopes string[]

Example (from schema)

{}

404

There is no user associated with this API token

application/json

Schema

Schema

code NoUserAssociatedWithIdentityEnum (string)

Possible values: [no_user_associated_with_identity]

description string
detail object

Example (from schema)

{
  "code": "no_user_associated_with_identity",
  "description": "string",
  "detail": {}
}

429

You have reached the rate limit for this type of request

application/json

Schema

Schema

code RateLimitReachedEnum (string)

Possible values: [rate_limit_reached]

description string

detail

object

total_permitted integer

The total number of requests per minute that are permitted

Example (from schema)

{
  "code": "rate_limit_reached",
  "description": "string",
  "detail": {
    "total_permitted": 0
  }
}

503

The service is currently unavailable, please try again later

application/json

Schema

Schema

code ServiceUnavailableEnum (string)

Possible values: [service_unavailable]

description string
detail object

Example (from schema)

{
  "code": "service_unavailable",
  "description": "string",
  "detail": {}
}

Loading...