Personal profiles and tokens¶

All API areas

Use the linked wire models for field constraints. Operation metadata does not enumerate every possible HTTP error or replace current server authorization.

On this page¶

Get (GET)
Update (PATCH)
Avatar (GET)
Set avatar (POST)
Delete avatar (DELETE)
People (GET)
Person avatar (GET)
List (GET)
Scopes (GET)
Create (POST)
Revoke (DELETE)

Get¶

HTTP

GET /api/v1/profile

Contract operation: ProfileController.get.

SDK	Method
Python	`profile`
TypeScript	`profile.get`
Java	`client.profile.get`

Parameters¶

No path, query or body arguments are declared in the canonical operation metadata.

Request and response¶

Contract	Value
Request schema	No request schema declared
Response schema	`UserProfile`
Success status	`200`
Declared encoding	`application/json`

Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.

Headers¶

No operation-specific headers are declared in the canonical metadata.

Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.

Update¶

HTTP

PATCH /api/v1/profile

Contract operation: ProfileController.update.

SDK	Method
Python	`update_profile`
TypeScript	`profile.update`
Java	`client.profile.update`

Parameters¶

These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.

Name	Location	Declared type	Required	Default
`body`	body	`Valid[Body[ProfileInput]]`	Yes	Not specified

Request and response¶

Contract	Value
Request schema	`ProfileUpdate`
Response schema	`UserProfile`
Success status	`200`
Declared encoding	`application/json`

Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.

Headers¶

No operation-specific headers are declared in the canonical metadata.

Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.

Avatar¶

HTTP

GET /api/v1/profile/avatar

Contract operation: ProfileController.avatar.

SDK	Method
Python	`avatar_download`
TypeScript	`profile.avatarDownload`
Java	`client.profile.avatar`

Parameters¶

No path, query or body arguments are declared in the canonical operation metadata.

Request and response¶

Contract	Value
Request schema	No request schema declared
Response schema	`BinaryDownload`
Success status	`200`
Declared encoding	`binary`

Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.

Headers¶

If-None-Match (optional; avatars only)

Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.

Set avatar¶

HTTP

POST /api/v1/profile/avatar

Contract operation: ProfileController.set_avatar.

SDK	Method
Python	`set_avatar`
TypeScript	`profile.uploadAvatar`
Java	`client.profile.uploadAvatar`

Parameters¶

No path, query or body arguments are declared in the canonical operation metadata.

Request and response¶

Contract	Value
Request schema	`AvatarUpload`
Response schema	`UserProfile`
Success status	`200`
Declared encoding	`image/png\|image/jpeg\|image/webp`

Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.

Headers¶

No operation-specific headers are declared in the canonical metadata.

Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.

Delete avatar¶

HTTP

DELETE /api/v1/profile/avatar

Contract operation: ProfileController.delete_avatar.

SDK	Method
Python	`delete_avatar`
TypeScript	`profile.deleteAvatar`
Java	`client.profile.deleteAvatar`

Parameters¶

No path, query or body arguments are declared in the canonical operation metadata.

Request and response¶

Contract	Value
Request schema	No request schema declared
Response schema	`UserProfile`
Success status	`200`
Declared encoding	`application/json`

Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.

Headers¶

No operation-specific headers are declared in the canonical metadata.

Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.

People¶

HTTP

GET /api/v1/tenants/{tenant_id}/people

Contract operation: ProfileController.people.

SDK	Method
Python	`people`
TypeScript	`people.list`
Java	`client.people.list`

Parameters¶

These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.

Name	Location	Declared type	Required	Default
`tenant_id`	path	`PathVar[str]`	Yes	Not specified
`workspace_id`	query	`QueryParam[str \| None]`	No	`null`
`q`	query	`QueryParam[str]`	No	`""`
`limit`	query	`QueryParam[int]`	No	`20`
`after`	query	`QueryParam[str]`	No	`""`

Request and response¶

Contract	Value
Request schema	No request schema declared
Response schema	`Page[Person]`
Success status	`200`
Declared encoding	`application/json`

Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.

Headers¶

No operation-specific headers are declared in the canonical metadata.

Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.

Person avatar¶

HTTP

GET /api/v1/tenants/{tenant_id}/people/{profile_id}/avatar

Contract operation: ProfileController.person_avatar.

SDK	Method
Python	`person_avatar`
TypeScript	`people.avatar`
Java	`client.people.avatar`

Parameters¶

These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.

Name	Location	Declared type	Required	Default
`tenant_id`	path	`PathVar[str]`	Yes	Not specified
`profile_id`	path	`PathVar[str]`	Yes	Not specified
`workspace_id`	query	`QueryParam[str \| None]`	No	`null`

Request and response¶

Contract	Value
Request schema	No request schema declared
Response schema	`BinaryDownload`
Success status	`200`
Declared encoding	`binary`

Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.

Headers¶

If-None-Match (optional; avatars only)

Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.

List¶

HTTP

GET /api/v1/tokens

Contract operation: PersonalTokenController.list.

SDK	Method
Python	`tokens`
TypeScript	`tokens.list`
Java	`client.tokens.list`

Parameters¶

These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.

Name	Location	Declared type	Required	Default
`q`	query	`QueryParam[str]`	No	`""`
`status`	query	`QueryParam[str]`	No	`"all"`
`page`	query	`QueryParam[int]`	No	`1`
`page_size`	query	`QueryParam[int]`	No	`25`
`sort`	query	`QueryParam[str]`	No	`"created_at"`
`order`	query	`QueryParam[str]`	No	`"desc"`

Request and response¶

Contract	Value
Request schema	No request schema declared
Response schema	`Page[PersonalToken]`
Success status	`200`
Declared encoding	`application/json`

Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.

Headers¶

No operation-specific headers are declared in the canonical metadata.

Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.

Scopes¶

HTTP

GET /api/v1/tokens/scopes

Contract operation: PersonalTokenController.scopes.

SDK	Method
Python	`token_scopes`
TypeScript	`tokens.scopes`
Java	`client.tokens.scopes`

Parameters¶

These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.

Name	Location	Declared type	Required	Default
`tenant_id`	query	`QueryParam[str]`	Yes	Not specified
`workspace_id`	query	`QueryParam[str \| None]`	No	`null`

Request and response¶

Contract	Value
Request schema	No request schema declared
Response schema	`TokenScopeOptions`
Success status	`200`
Declared encoding	`application/json`

Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.

Headers¶

No operation-specific headers are declared in the canonical metadata.

Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.

Create¶

HTTP

POST /api/v1/tokens

Contract operation: PersonalTokenController.create.

SDK	Method
Python	`create_token`
TypeScript	`tokens.create`
Java	`client.tokens.create`

Parameters¶

These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.

Name	Location	Declared type	Required	Default
`body`	body	`Valid[Body[TokenInput]]`	Yes	Not specified

Request and response¶

Contract	Value
Request schema	`TokenInput`
Response schema	`TokenCreated`
Success status	`201`
Declared encoding	`application/json`

Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.

Headers¶

No operation-specific headers are declared in the canonical metadata.

Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.

Revoke¶

HTTP

DELETE /api/v1/tokens/{token_id}

Contract operation: PersonalTokenController.revoke.

SDK	Method
Python	`revoke_token`
TypeScript	`tokens.revoke`
Java	`client.tokens.revoke`

Parameters¶

These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.

Name	Location	Declared type	Required	Default
`token_id`	path	`PathVar[str]`	Yes	Not specified

Request and response¶

Contract	Value
Request schema	No request schema declared
Response schema	No response body
Success status	`204`
Declared encoding	`application/json`

Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.

Headers¶

No operation-specific headers are declared in the canonical metadata.

Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.