Authentication

> Auto-generated from the OpenAPI spec. Method names shown are the manifest > (canonical) names; per-language casing is applied by each SDK.

Record handle: ref(id) → a lazy handle to one OAuth2Client (get/update/delete, field values, related records). See record handles.

`authorizeAuthOauth`

GET /auth/oauth/authorize

OAuth2 authorization endpoint — OAuth2 Authorization Endpoint (Authorization Code Flow)

Parameter	In	Required	Description
`response_type`	query	yes	Must be 'code' for authorization code flow
`client_id`	query	yes	OAuth2 client ID
`redirect_uri`	query	yes	Registered redirect URI
`state`	query	no	Optional state parameter for CSRF protection
`scope`	query	no	Optional space-separated scopes

Returns: void · Cost: 1 API call.

`createAuthOauthClient`

POST /auth/oauth/client

Create OAuth2 client — Registers a new OAuth2 client. Requires clientName and redirectUris (HTTPS only, max 5, localhost allowed). Returns auto-generated clientId and clientSecret (secret shown only once).

Parameter	In	Required	Description
`body`	body	yes

Returns: OAuth2Client · Cost: 1 API call.

`createAuthOauthToken`

POST /auth/oauth/token

OAuth2 token endpoint — Exchanges an authorization code for an access/refresh token pair (grant_type: authorization_code) or refreshes an expired access token (grant_type: refresh_token). Returns access_token, token_type: Bearer, expires_in (seconds), and refresh_token.

Parameter	In	Required	Description
`body`	body	yes

Returns: any · Cost: 1 API call.

`createUserToken`

POST /auth/{userId}/token

Create an API token — Creates a new private API token for the user with optional per-module CRUD permissions. The token value is returned only once in this response.

Parameter	In	Required	Description
`userId`	path	yes	ID of user
`body`	body	yes	Token to be created
`filter`	query	no	Filter expression to narrow results. Format: `field operator value`. Multiple conditions are joined with `;` or `&` (AND) or `\|` (OR). Conditions can be grouped with parentheses. Supported operators: `=` (equals; also matches NULL when value is empty), `!=` (not equals), `>`, `>=`, `<`, `<=`, `~` (LIKE, use `%` as wildcard; empty value matches NULL/empty), `!~` (NOT LIKE), `...` (IN set, comma-separated: `statusId...1,2,3`). OR across values for one field: `status=(active\|pending)`. Examples: `filter=name=Acme`, `filter=created>=2024-01-01;assigneeId=`, `filter=name~%smith%;statusId...1,2,3`, `filter=(status=active\|status=pending)&spaceId=5`.
`offset`	query	no	Zero-based index of the first record to return. Use together with `limit` for pagination. Example: `offset=20&limit=10` returns records 21–30.
`limit`	query	no	Maximum number of records to return. Use together with `offset` for pagination.
`order`	query	no	Sort order for results. Comma-separated list of `field;DIRECTION` pairs. Direction is `ASC` or `DESC` (default `DESC` when omitted). Example: `order=name;ASC` or `order=id;ASC,name;DESC`.

Returns: Token · Cost: 1 API call.

`deleteAuthOauthClient`

DELETE /auth/oauth/client/{clientId}

Delete OAuth2 client — Revokes the OAuth2 client and immediately invalidates all tokens issued to it.

Parameter	In	Required	Description
`clientId`	path	yes	ID of OAuth2 client

Returns: void · Cost: 1 API call.

`deleteUserToken`

DELETE /auth/{userId}/token/{tokenId}

Delete an API token

Parameter	In	Required	Description
`userId`	path	yes	ID of user
`tokenId`	path	yes	ID of token

Returns: any · Cost: 1 API call.

`getAuthOauthClient`

GET /auth/oauth/client/{clientId}

Get OAuth2 client — Handle OAuth2 client CRUD operations Route: auth/oauth/client[/<subResourceId>]

Parameter	In	Required	Description
`clientId`	path	yes	ID of OAuth2 client

Returns: OAuth2Client · Cost: 1 API call.

`getOauthTokenInfo`

GET /auth/oauth/token-info

OAuth2 token info endpoint — Validates an access token and returns its metadata: client_id, scope array, and exp (expiration timestamp). Returns an OAuth error if the token is invalid or expired.

Parameter	In	Required	Description
`token`	query	yes	Access token

Returns: any · Cost: 1 API call.

`getUserToken`

GET /auth/{userId}/token/{tokenId}

Get an API token by ID

Parameter	In	Required	Description
`userId`	path	yes	ID of user
`tokenId`	path	yes	ID of token

Returns: Token · Cost: 1 API call.

`listAuthOauthClient`

GET /auth/oauth/client

List OAuth2 clients

Parameter	In	Required	Description
`filter`	query	no	Filter expression to narrow results. Format: `field operator value`. Multiple conditions are joined with `;` or `&` (AND) or `\|` (OR). Conditions can be grouped with parentheses. Supported operators: `=` (equals; also matches NULL when value is empty), `!=` (not equals), `>`, `>=`, `<`, `<=`, `~` (LIKE, use `%` as wildcard; empty value matches NULL/empty), `!~` (NOT LIKE), `...` (IN set, comma-separated: `statusId...1,2,3`). OR across values for one field: `status=(active\|pending)`. Examples: `filter=name=Acme`, `filter=created>=2024-01-01;assigneeId=`, `filter=name~%smith%;statusId...1,2,3`, `filter=(status=active\|status=pending)&spaceId=5`.
`offset`	query	no	Zero-based index of the first record to return. Use together with `limit` for pagination. Example: `offset=20&limit=10` returns records 21–30.
`limit`	query	no	Maximum number of records to return. Use together with `offset` for pagination.
`order`	query	no	Sort order for results. Comma-separated list of `field;DIRECTION` pairs. Direction is `ASC` or `DESC` (default `DESC` when omitted). Example: `order=name;ASC` or `order=id;ASC,name;DESC`.

Returns: list<OAuth2Client> · Cost: 1 API call per page (lazy paginator).

`listUserTokens`

GET /auth/{userId}/token

List API tokens

Parameter	In	Required	Description
`userId`	path	yes	ID of user

Returns: list<Token> · Cost: 1 API call per page (lazy paginator).

`renewAuthOauth`

POST /auth/oauth/renew

Renew access token using refresh token — Exchanges a refresh_token for a new access_token and refresh_token pair, invalidating the previous refresh token.

Parameter	In	Required	Description
`body`	body	yes

Returns: any · Cost: 1 API call.

`revokeAuthOauth`

POST /auth/oauth/revoke

OAuth2 token revocation endpoint — Revokes an access or refresh token. Returns {revoked: boolean} without disclosing whether the token previously existed.

Parameter	In	Required	Description
`body`	body	yes

Returns: any · Cost: 1 API call.

`updateAuthOauthClient`

PUT /auth/oauth/client/{clientId}

Update OAuth2 client — Updates client name, redirect URIs, or scopes. Include regenerateSecret: true in the request body to rotate the clientSecret.

Parameter	In	Required	Description
`clientId`	path	yes	ID of OAuth2 client
`body`	body	yes

Returns: OAuth2Client · Cost: 1 API call.

`updateUserToken`

PUT /auth/{userId}/token/{tokenId}

Update an API token

Parameter	In	Required	Description
`userId`	path	yes	ID of user
`tokenId`	path	yes	ID of token
`body`	body	yes

Returns: any · Cost: 1 API call.

AIFeatures

Categories