ReferenceUsers
ResourcesUsers

Users

Get current user

GET
/api/v1/users

Authorization

ApiKey
Authorization<token>

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/users"
{  "username": "string",  "email": "string",  "name": "string",  "kind": "string",  "theme": 0,  "organization": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Patch current user

PATCH
/api/v1/users

Authorization

ApiKey
Authorization<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/users" \  -H "Content-Type: application/json" \  -d '{}'
{  "username": "string",  "email": "string",  "name": "string",  "kind": "string",  "theme": 0,  "organization": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Update current user

PUT
/api/v1/users

Authorization

ApiKey
Authorization<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/users" \  -H "Content-Type: application/json" \  -d '{}'
{  "username": "string",  "email": "string",  "name": "string",  "kind": "string",  "theme": 0,  "organization": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

User History

GET
/api/v1/users/history

Authorization

ApiKey
Authorization<token>

In: header

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/users/history"
{  "count": 0,  "results": [    {      "actor": "string",      "owner": "string",      "created_at": "2019-08-24T14:15:22Z",      "event_action": "string",      "event_subject": "string",      "object_name": "string",      "object_uuid": "string",      "object_parent": "string"    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

User suggestions

GET
/api/v1/users/suggestions

Authorization

ApiKey
Authorization<token>

In: header

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/users/suggestions"
{}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

List tokens

GET
/api/v1/users/tokens

Authorization

ApiKey
Authorization<token>

In: header

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/users/tokens"
{  "count": 0,  "results": [    {      "uuid": "string",      "key": "string",      "name": "string",      "scopes": [        "string"      ],      "services": [        "string"      ],      "started_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "expiration": 0    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Create token

POST
/api/v1/users/tokens

Authorization

ApiKey
Authorization<token>

In: header

Request Body

application/json

Token body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/users/tokens" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "key": "string",  "name": "string",  "scopes": [    "string"  ],  "services": [    "string"  ],  "started_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "expiration": 0}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Patch token

PATCH
/api/v1/users/tokens/{token.uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

token.uuid*string

UUID

Request Body

application/json

Token body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/users/tokens/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "key": "string",  "name": "string",  "scopes": [    "string"  ],  "services": [    "string"  ],  "started_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "expiration": 0}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Update token

PUT
/api/v1/users/tokens/{token.uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

token.uuid*string

UUID

Request Body

application/json

Token body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/users/tokens/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "key": "string",  "name": "string",  "scopes": [    "string"  ],  "services": [    "string"  ],  "started_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "expiration": 0}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get token

GET
/api/v1/users/tokens/{uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

uuid*string

UUid of the namespace

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/users/tokens/string"
{  "uuid": "string",  "key": "string",  "name": "string",  "scopes": [    "string"  ],  "services": [    "string"  ],  "started_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "expiration": 0}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Delete token

DELETE
/api/v1/users/tokens/{uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

uuid*string

UUid of the namespace

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v1/users/tokens/string"
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

User workspaces

GET
/api/v1/users/workspaces

Authorization

ApiKey
Authorization<token>

In: header

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/users/workspaces"
{}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}
Teams
Project Dashboards

On this page

Get current userPatch current userUpdate current userUser HistoryUser suggestionsList tokensCreate tokenPatch tokenUpdate tokenGet tokenDelete tokenUser workspaces

Actions

Give us feedback