API: Identity

Generated from the API's OpenAPI schema. Paths are relative to https://cloud.tebibhost.com. Authentication, errors, pagination and idempotency are on the API overview.

GET/api/v1/invitations/{token}

Preview Invitation (previewInvitation)

IAM action: none (public, no sign-in)

Parameter	In	Type	Description
token required	path	string

Responses

• 200 OK (InvitationPreview)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of InvitationPreview

Field	Type	Description
account_exists	boolean
email	string
expires_at	string (date-time)
organization_name	string

POST/api/v1/invitations/{token}/accept

Accept Invitation (acceptInvitation)

Join the organization. New people set a password; existing users must be signed in.

IAM action: none (public, no sign-in)

Parameter	In	Type	Description
token required	path	string

Request body (JSON, AcceptIn)

Field	Type	Description
full_name	string	Default: "".
password	string (nullable)

Responses

• 200 OK (AcceptOut)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of AcceptOut

Field	Type	Description
created_account	boolean
email	string
organization_id	string
user_id	string

GET/api/v1/me

Me (me)

IAM action: none (any signed-in caller)

Responses

• 200 OK (MeOut)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of MeOut

Field	Type	Description
bound_organization_id	string (nullable)
email	string (nullable)
id	string
kind	string
mfa	boolean
organizations	array of MembershipOut

GET/api/v1/me/preferences

Get Preferences (getPreferences)

IAM action: none (any signed-in caller)

Responses

• 200 OK (PreferencesOut)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of PreferencesOut

Field	Type	Description
onboarding_dismissed	array of string
theme	"system" | "dark" | "light"
theme_saved	boolean

PATCH/api/v1/me/preferences

Update Preferences (updatePreferences)

IAM action: none (any signed-in caller)

Request body (JSON, PreferencesPatch)

Field	Type	Description
onboarding	OnboardingVisibility (nullable)
theme	"system" | "dark" | "light" (nullable)

Responses

• 200 OK (PreferencesOut)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of PreferencesOut

Field	Type	Description
onboarding_dismissed	array of string
theme	"system" | "dark" | "light"
theme_saved	boolean

GET/api/v1/orgs/{organization_id}/invitations

List Invitations (listInvitations)

IAM action: iam:DescribeInvitation

Parameter	In	Type	Description
organization_id required	path	string
limit	query	integer (nullable)
cursor	query	string (nullable)

Responses

• 200 OK (Page_InvitationOut_)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of Page_InvitationOut_

Field	Type	Description
items	array of InvitationOut
next_cursor	string (nullable)

POST/api/v1/orgs/{organization_id}/invitations

Invite (invite)

IAM action: iam:CreateInvitationiam:AddUserToGroup

Parameter	In	Type	Description
organization_id required	path	string

Request body (JSON, InvitationIn)

Field	Type	Description
email required	string
groups	array of string

Responses

• 201 Created (InvitationOut)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of InvitationOut

Field	Type	Description
accepted_at	string (date-time) (nullable)
created_at	string (date-time)
email	string
expires_at	string (date-time)
groups	array of string
id	string
invited_by	string
organization_id	string
state	string
trn	string

DELETE/api/v1/orgs/{organization_id}/invitations/{invitation_id}

Revoke Invitation (revokeInvitation)

IAM action: iam:DeleteInvitation

Parameter	In	Type	Description
organization_id required	path	string
invitation_id required	path	string

Responses

• 204 No Content
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

GET/api/v1/orgs/{organization_id}/onboarding

Get Onboarding (getOnboarding)

IAM action: org:DescribeOrganization

Parameter	In	Type	Description
organization_id required	path	string

Responses

• 200 OK (OnboardingOut)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of OnboardingOut

Field	Type	Description
complete	boolean
dismissed	boolean
organization_id	string
steps	array of OnboardingStep

GET/api/v1/orgs/{organization_id}/service-accounts

List Service Accounts (listServiceAccounts)

IAM action: iam:DescribeServiceAccount

Parameter	In	Type	Description
organization_id required	path	string
limit	query	integer (nullable)
cursor	query	string (nullable)

Responses

• 200 OK (Page_ServiceAccountOut_)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of Page_ServiceAccountOut_

Field	Type	Description
items	array of ServiceAccountOut
next_cursor	string (nullable)

POST/api/v1/orgs/{organization_id}/service-accounts

Create Service Account (createServiceAccount)

IAM action: iam:CreateServiceAccount

Parameter	In	Type	Description
organization_id required	path	string

Request body (JSON, ServiceAccountIn)

Field	Type	Description
description	string	Default: "".
name required	string
tags	object

Responses

• 201 Created (ServiceAccountOut)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of ServiceAccountOut

Field	Type	Description
created_at	string (date-time)
description	string
disabled	boolean
id	string
name	string
tags	object
trn	string

GET/api/v1/orgs/{organization_id}/service-accounts/{account_id}

Get Service Account (getServiceAccount)

IAM action: iam:DescribeServiceAccount

Parameter	In	Type	Description
organization_id required	path	string
account_id required	path	string

Responses

• 200 OK (ServiceAccountOut)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of ServiceAccountOut

Field	Type	Description
created_at	string (date-time)
description	string
disabled	boolean
id	string
name	string
tags	object
trn	string

PATCH/api/v1/orgs/{organization_id}/service-accounts/{account_id}

Update Service Account (updateServiceAccount)

IAM action: iam:UpdateServiceAccount

Parameter	In	Type	Description
organization_id required	path	string
account_id required	path	string

Request body (JSON, ServiceAccountPatch)

Field	Type	Description
description	string (nullable)
disabled	boolean (nullable)
tags	object (nullable)

Responses

• 200 OK (ServiceAccountOut)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of ServiceAccountOut

Field	Type	Description
created_at	string (date-time)
description	string
disabled	boolean
id	string
name	string
tags	object
trn	string

DELETE/api/v1/orgs/{organization_id}/service-accounts/{account_id}

Delete Service Account (deleteServiceAccount)

IAM action: iam:DeleteServiceAccount

Parameter	In	Type	Description
organization_id required	path	string
account_id required	path	string

Responses

• 204 No Content
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

GET/api/v1/orgs/{organization_id}/service-accounts/{owner_id}/access-keys

List Service Account Keys (listServiceAccountKeys)

IAM action: iam:DescribeAccessKey

Parameter	In	Type	Description
organization_id required	path	string
owner_id required	path	string

Responses

• 200 OK (array of AccessKeyOut)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

POST/api/v1/orgs/{organization_id}/service-accounts/{owner_id}/access-keys

Create Service Account Key (createServiceAccountKey)

IAM action: iam:CreateAccessKeyiam:CreateNonExpiringAccessKey

Parameter	In	Type	Description
organization_id required	path	string
owner_id required	path	string

Request body (JSON, AccessKeyIn)

Field	Type	Description
allowed_cidrs	array of string
description	string	Default: "".
expires_at	string (date-time) (nullable)
never_expires	boolean	Default: false.

Responses

• 201 Created (AccessKeyCreatedOut)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of AccessKeyCreatedOut

Field	Type	Description
allowed_cidrs	array of string
created_at	string (date-time)
description	string
disables_at	string (date-time) (nullable)
expires_at	string (date-time) (nullable)
id	string
last_used_at	string (date-time) (nullable)
last_used_ip	string (nullable)
owner	string
secret	string
status	string
status_reason	string
token	string
trn	string

PATCH/api/v1/orgs/{organization_id}/service-accounts/{owner_id}/access-keys/{key_id}

Update Service Account Key (updateServiceAccountKey)

IAM action: iam:UpdateAccessKey

Parameter	In	Type	Description
organization_id required	path	string
owner_id required	path	string
key_id required	path	string

Request body (JSON, AccessKeyPatch)

Field	Type	Description
description	string (nullable)
status	string (nullable)

Responses

• 200 OK (AccessKeyOut)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of AccessKeyOut

Field	Type	Description
allowed_cidrs	array of string
created_at	string (date-time)
description	string
disables_at	string (date-time) (nullable)
expires_at	string (date-time) (nullable)
id	string
last_used_at	string (date-time) (nullable)
last_used_ip	string (nullable)
owner	string
status	string
status_reason	string
trn	string

DELETE/api/v1/orgs/{organization_id}/service-accounts/{owner_id}/access-keys/{key_id}

Delete Service Account Key (deleteServiceAccountKey)

IAM action: iam:DeleteAccessKey

Parameter	In	Type	Description
organization_id required	path	string
owner_id required	path	string
key_id required	path	string

Responses

• 204 No Content
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

GET/api/v1/orgs/{organization_id}/users

List Users (listUsers)

IAM action: iam:DescribeUser

Parameter	In	Type	Description
organization_id required	path	string
limit	query	integer (nullable)
cursor	query	string (nullable)

Responses

• 200 OK (Page_OrgUserOut_)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of Page_OrgUserOut_

Field	Type	Description
items	array of OrgUserOut
next_cursor	string (nullable)

GET/api/v1/orgs/{organization_id}/users/{owner_id}/access-keys

List User Keys (listUserKeys)

IAM action: iam:DescribeAccessKey

Parameter	In	Type	Description
organization_id required	path	string
owner_id required	path	string

Responses

• 200 OK (array of AccessKeyOut)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

POST/api/v1/orgs/{organization_id}/users/{owner_id}/access-keys

Create User Key (createUserKey)

IAM action: iam:CreateAccessKey

Parameter	In	Type	Description
organization_id required	path	string
owner_id required	path	string

Request body (JSON, AccessKeyIn)

Field	Type	Description
allowed_cidrs	array of string
description	string	Default: "".
expires_at	string (date-time) (nullable)
never_expires	boolean	Default: false.

Responses

• 201 Created (AccessKeyCreatedOut)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of AccessKeyCreatedOut

Field	Type	Description
allowed_cidrs	array of string
created_at	string (date-time)
description	string
disables_at	string (date-time) (nullable)
expires_at	string (date-time) (nullable)
id	string
last_used_at	string (date-time) (nullable)
last_used_ip	string (nullable)
owner	string
secret	string
status	string
status_reason	string
token	string
trn	string

PATCH/api/v1/orgs/{organization_id}/users/{owner_id}/access-keys/{key_id}

Update User Key (updateUserKey)

IAM action: iam:UpdateAccessKey

Parameter	In	Type	Description
organization_id required	path	string
owner_id required	path	string
key_id required	path	string

Request body (JSON, AccessKeyPatch)

Field	Type	Description
description	string (nullable)
status	string (nullable)

Responses

• 200 OK (AccessKeyOut)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of AccessKeyOut

Field	Type	Description
allowed_cidrs	array of string
created_at	string (date-time)
description	string
disables_at	string (date-time) (nullable)
expires_at	string (date-time) (nullable)
id	string
last_used_at	string (date-time) (nullable)
last_used_ip	string (nullable)
owner	string
status	string
status_reason	string
trn	string

DELETE/api/v1/orgs/{organization_id}/users/{owner_id}/access-keys/{key_id}

Delete User Key (deleteUserKey)

IAM action: iam:DeleteAccessKey

Parameter	In	Type	Description
organization_id required	path	string
owner_id required	path	string
key_id required	path	string

Responses

• 204 No Content
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

GET/api/v1/orgs/{organization_id}/users/{user_id}

Get User (getUser)

IAM action: iam:DescribeUser

Parameter	In	Type	Description
organization_id required	path	string
user_id required	path	string

Responses

• 200 OK (OrgUserOut)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of OrgUserOut

Field	Type	Description
email	string
full_name	string
groups	array of string
id	string
joined_at	string (date-time)
mfa_enabled	boolean
tags	object
trn	string

PATCH/api/v1/orgs/{organization_id}/users/{user_id}

Update User (updateUser)

IAM action: iam:UpdateUser

Parameter	In	Type	Description
organization_id required	path	string
user_id required	path	string

Request body (JSON, OrgUserPatch)

Field	Type	Description
tags	object (nullable)

Responses

• 200 OK (OrgUserOut)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of OrgUserOut

Field	Type	Description
email	string
full_name	string
groups	array of string
id	string
joined_at	string (date-time)
mfa_enabled	boolean
tags	object
trn	string

DELETE/api/v1/orgs/{organization_id}/users/{user_id}

Remove User (removeUser)

Remove a user from the organization: memberships, attachments, keys and sessions go.

IAM action: iam:RemoveUser

Parameter	In	Type	Description
organization_id required	path	string
user_id required	path	string

Responses

• 204 No Content
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)