Skip to main content
POST
TypeScript (SDK)

Authorizations

tql_api_key
string
header
required

Headers

Connect-Protocol-Version
enum<number>
default:1
required

Define the version of the Connect protocol

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
assumedRoleNames
string[]

Exact, case-sensitive role names in the caller's organization. Merged with legacy assumed_roles IDs and deduplicated. The existing member-role and calling API-key scope restrictions apply to both forms.

name
string | null
expirySeconds
integer | null
assumedRoles
string[]

Bounded by the roles the caller holds. Legacy role IDs. Prefer assumed_role_names.

inheritAllRoles
boolean | null

Required when both role lists are empty, so omission cannot mint a wide key.

clientId
string | null
fullMemberAccess
boolean

Also reach the owner's own items; otherwise the key sees only what the assumed roles can see.

suppressSuperadmin
boolean

Drop @textql.com superadmin elevation. No-op for non-superadmins.

Response

Success

CreateApiKeyResponse minus its deprecated api_key_hash alias.

apiKey
api_key · object
apiKeySecret
string

Only ever returned here; the server stores a hash and cannot reissue it.