Skip to main content

API specs

API docs by Redocly

Secrets Vault OIDC Service (0.1.0)

Download OpenAPI specification:Download

Secrets Vault OpenID Connect service with image-based Zero-Knowledge Proof authentication

Authentication

Register

query Parameters
Auth Req Id (string) or Auth Req Id (null) (Auth Req Id)
Request Body schema: application/json
required
username
required
string (Username) ^[a-zA-Z0-9_.@-]+$
email
required
string <email> (Email)
encrypted_commitment
required
string (Encrypted Commitment)
proto_version
required
string (Proto Version)
LogData (object) or null

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "user@example.com",
  • "encrypted_commitment": "string",
  • "proto_version": "string",
  • "log_data": {
    }
}

Response samples

Content type
application/json
null

Get Challenge

query Parameters
Auth Req Id (string) or Auth Req Id (null) (Auth Req Id)
Request Body schema: application/json
required
username
required
string (Username)
cipherKey
required
string (Cipherkey)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "cipherKey": "string"
}

Response samples

Content type
application/json
{
  • "challenge_data": "string",
  • "proto_version": "string"
}

Authenticate

query Parameters
Auth Req Id (string) or Auth Req Id (null) (Auth Req Id)
Request Body schema: application/json
required
username
required
string (Username)
cipherKey
required
string (Cipherkey)
challenge_id
required
string (Challenge Id)
challenge_data
required
string (Challenge Data)
BERForm (object) or null
LogData (object) or null

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "cipherKey": "string",
  • "challenge_id": "string",
  • "challenge_data": "string",
  • "ber": {
    },
  • "log_data": {
    }
}

Response samples

Content type
application/json
{
  • "nonce": "string",
  • "need_verify": false
}

Sign In

query Parameters
oid_nonce
required
string (Oid Nonce)
auth_req_id
required
string (Auth Req Id)

Responses

Response samples

Content type
application/json
null

Oidc Logout Redirect

query Parameters
required
Id Token Hint (string) or Id Token Hint (null) (Id Token Hint)
State (string) or State (null) (State)
Post Logout Redirect Uri (string) or Post Logout Redirect Uri (null) (Post Logout Redirect Uri)
Client Id (string) or Client Id (null) (Client Id)

Responses

Response samples

Content type
application/json
null

Oidc Logout

Request Body schema: application/x-www-form-urlencoded
required
id_token_hint
required
string (Id Token Hint)
State (string) or State (null) (State)
Post Logout Redirect Uri (string) or Post Logout Redirect Uri (null) (Post Logout Redirect Uri)
Client Id (string) or Client Id (null) (Client Id)

Responses

Response samples

Content type
application/json
null

Logout

Authorizations:
APIKeyHeaderHTTPBearer

Responses

Response samples

Content type
application/json
null

Revoke Session

Authorizations:
APIKeyHeaderHTTPBearer
Request Body schema: application/json
required
session_id
required
string (Session Id)

Responses

Request samples

Content type
application/json
{
  • "session_id": "string"
}

Response samples

Content type
application/json
{
  • "session_id": "string"
}

Revoke All Session

Authorizations:
APIKeyHeaderHTTPBearer

Responses

Response samples

Content type
application/json
null

List Sessions

Authorizations:
APIKeyHeaderHTTPBearer

Responses

Response samples

Content type
application/json
{
  • "sessions": [
    ],
  • "total": 0
}

Verify Email

query Parameters
code
required
string (Code)

Responses

Response samples

Content type
application/json
null

Get Client

query Parameters
client_id
required
string (Client Id)
tenant_id
required
any (Tenant Id)

Responses

Response samples

Content type
application/json
{
  • "client_id": "string",
  • "name": "string",
  • "tenant_id": "string",
  • "logo_uri": "string",
  • "op_policy_url": "string",
  • "op_tos_url": "string",
  • "op_user_agreement_url": "string",
  • "client_uri": "string",
  • "client_logout_uri": "string",
  • "register_enable": false,
  • "tenant_name": "string",
  • "has_profile": false
}

Get Client Tenant

query Parameters
client_id
required
string (Client Id)
tenant_id
required
any (Tenant Id)

Responses

Response samples

Content type
application/json
{
  • "client": {
    },
  • "tenant": {
    }
}

Get Client Tenant Signed

query Parameters
client_id
required
string (Client Id)
tenant_id
required
any (Tenant Id)

Responses

Response samples

Content type
application/json
{
  • "data": "string"
}

Request Reset Password

query Parameters
client_id
required
string (Client Id)
tenant_id
required
string (Tenant Id)
Request Body schema: application/json
required
username
required
string (Username)
email
required
string (Email)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "string"
}

Response samples

Content type
application/json
null

Reset Password Code

Request Body schema: application/json
required
code
required
string (Code)
username
required
string (Username)
encrypted_commitment
required
string (Encrypted Commitment)
proto_version
required
string (Proto Version)
LogData (object) or null

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "username": "string",
  • "encrypted_commitment": "string",
  • "proto_version": "string",
  • "log_data": {
    }
}

Response samples

Content type
application/json
null

Change Password

Authorizations:
APIKeyHeaderHTTPBearer
Request Body schema: application/json
required
encrypted_commitment
required
string (Encrypted Commitment)
proto_version
required
string (Proto Version)
LogData (object) or null

Responses

Request samples

Content type
application/json
{
  • "encrypted_commitment": "string",
  • "proto_version": "string",
  • "log_data": {
    }
}

Response samples

Content type
application/json
null

Aux Challenge

Authorizations:
APIKeyHeaderHTTPBearer
Request Body schema: application/json
required
cipherKey
required
string (Cipherkey)

Responses

Request samples

Content type
application/json
{
  • "cipherKey": "string"
}

Response samples

Content type
application/json
null

OIDC

Authorize

query Parameters
response_type
required
string (Response Type)
client_id
required
string (Client Id)
redirect_uri
required
string (Redirect Uri)
tenant_id
required
string (Tenant Id)
Scope (string) or Scope (null) (Scope)
Default: "openid"
State (string) or State (null) (State)
Nonce (string) or Nonce (null) (Nonce)
Prompt (string) or Prompt (null) (Prompt)
Code Challenge (string) or Code Challenge (null) (Code Challenge)
"S256" (string) or Code Challenge Method (null) (Code Challenge Method)
Login Hint (string) or Login Hint (null) (Login Hint)
Email Hint (string) or Email Hint (null) (Email Hint)

Responses

Response samples

Content type
application/json
null

Token Exchange

Request Body schema: application/x-www-form-urlencoded
required
client_id
required
string (Client Id)
grant_type
required
string (Grant Type)
tenant_id
required
string (Tenant Id)
Client Secret (string) or Client Secret (null) (Client Secret)
Redirect Uri (string) or Redirect Uri (null) (Redirect Uri)
Code (string) or Code (null) (Code)
Refresh Token (string) or Refresh Token (null) (Refresh Token)
Code Verifier (string) or Code Verifier (null) (Code Verifier)

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "id_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 0
}

Userinfo

Provide user claims to clients.

Authorizations:
APIKeyHeaderHTTPBearer

Responses

Response samples

Content type
application/json
{
  • "sub": "string",
  • "created_at": 0,
  • "name": "",
  • "email": "",
  • "email_verified": false,
  • "updated_at": 0,
  • "locale": "string",
  • "tenant_id": "string"
}

Revoke

Authorizations:
APIKeyHeaderHTTPBearer
Request Body schema: application/x-www-form-urlencoded
required
token
required
string (Token)
TokenType (string) or null

Responses

Response samples

Content type
application/json
null

Get Jwks

Return the JSON Web Key Set (JWKS) for token verification.

path Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
null

Get Openid Configuration

Return the OpenID Connect configuration.

path Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
null

Authorize

path Parameters
tenant_id
required
string (Tenant Id)
query Parameters
response_type
required
string (Response Type)
client_id
required
string (Client Id)
redirect_uri
required
string (Redirect Uri)
Scope (string) or Scope (null) (Scope)
Default: "openid"
State (string) or State (null) (State)
Nonce (string) or Nonce (null) (Nonce)
Prompt (string) or Prompt (null) (Prompt)
Code Challenge (string) or Code Challenge (null) (Code Challenge)
"S256" (string) or Code Challenge Method (null) (Code Challenge Method)
Login Hint (string) or Login Hint (null) (Login Hint)
Email Hint (string) or Email Hint (null) (Email Hint)

Responses

Response samples

Content type
application/json
null

Token Exchange

path Parameters
tenant_id
required
string (Tenant Id)
Request Body schema: application/x-www-form-urlencoded
required
client_id
required
string (Client Id)
grant_type
required
string (Grant Type)
Client Secret (string) or Client Secret (null) (Client Secret)
Redirect Uri (string) or Redirect Uri (null) (Redirect Uri)
Code (string) or Code (null) (Code)
Refresh Token (string) or Refresh Token (null) (Refresh Token)
Code Verifier (string) or Code Verifier (null) (Code Verifier)

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "id_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 0
}

Get Jwks Standard

Return the JSON Web Key Set (JWKS) for token verification.

path Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
null

Get Openid Configuration Standard

Return the OpenID Connect configuration.

path Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
null

Authorize Standard

path Parameters
tenant_id
required
string (Tenant Id)
query Parameters
response_type
required
string (Response Type)
client_id
required
string (Client Id)
redirect_uri
required
string (Redirect Uri)
Scope (string) or Scope (null) (Scope)
Default: "openid"
State (string) or State (null) (State)
Nonce (string) or Nonce (null) (Nonce)
Prompt (string) or Prompt (null) (Prompt)
Code Challenge (string) or Code Challenge (null) (Code Challenge)
"S256" (string) or Code Challenge Method (null) (Code Challenge Method)
Login Hint (string) or Login Hint (null) (Login Hint)
Email Hint (string) or Email Hint (null) (Email Hint)

Responses

Response samples

Content type
application/json
null

Token Exchange Standard

path Parameters
tenant_id
required
string (Tenant Id)
Request Body schema: application/x-www-form-urlencoded
required
client_id
required
string (Client Id)
grant_type
required
string (Grant Type)
Client Secret (string) or Client Secret (null) (Client Secret)
Redirect Uri (string) or Redirect Uri (null) (Redirect Uri)
Code (string) or Code (null) (Code)
Refresh Token (string) or Refresh Token (null) (Refresh Token)
Code Verifier (string) or Code Verifier (null) (Code Verifier)

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "id_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 0
}

OIDC special flows

Get Jwks Standard

Return the JSON Web Key Set (JWKS) for token verification.

path Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
null

Get Openid Configuration Standard

Return the OpenID Connect configuration.

path Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
null

Authorize Mfa

path Parameters
tenant_id
required
string (Tenant Id)
Request Body schema: application/x-www-form-urlencoded
required
client_id
required
string (Client Id)
redirect_uri
required
string (Redirect Uri)
response_type
string (Response Type)
Default: "id_token"
scope
string (Scope)
Default: "openid"
response_mode
string (Response Mode)
Default: "form_post"
State (string) or State (null) (State)
Nonce (string) or Nonce (null) (Nonce)
Id Token Hint (string) or Id Token Hint (null) (Id Token Hint)
Claims (string) or Claims (null) (Claims)

Responses

Response samples

Content type
application/json
null

Microsoft-Mfa-Form

path Parameters
flow_id
required
string (Flow Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

health

Health

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "version": "string",
  • "env": "string"
}

User

Get Current User

Authorizations:
APIKeyHeaderHTTPBearer

Responses

Response samples

Content type
application/json
{
  • "user_id": "string",
  • "username": "string",
  • "email": "user@example.com",
  • "tenant_id": "string",
  • "is_disabled": false,
  • "is_verified": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "locale": "string",
  • "roles": [
    ],
  • "external_id": "string"
}

List Users

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
query Parameters
username
string (Username) <= 128 characters
Default: ""
email
string (Email) <= 128 characters
Default: ""
limit
integer (Limit) ( 0 .. 500 ]
Default: 10
offset
integer (Offset) >= 0
Default: 0
sort_direction
integer (Sort Direction) [ -1 .. 1 ]
Default: -1
sort_by
string (UserSortField)
Default: "created_at"
Enum: "created_at" "username" "email"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": true,
  • "total_count": 0
}

Get User By Name

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
username
required
string (Username) <= 128 characters

Responses

Response samples

Content type
application/json
{
  • "user_id": "string",
  • "username": "string",
  • "email": "user@example.com",
  • "tenant_id": "string",
  • "is_disabled": false,
  • "is_verified": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "locale": "string",
  • "roles": [
    ],
  • "external_id": "string"
}

Get User

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
user_id
required
string (User Id)

Responses

Response samples

Content type
application/json
{
  • "user_id": "string",
  • "username": "string",
  • "email": "user@example.com",
  • "tenant_id": "string",
  • "is_disabled": false,
  • "is_verified": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "locale": "string",
  • "roles": [
    ],
  • "external_id": "string"
}

Update User

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
user_id
required
string (User Id)
tenant_id
required
string (Tenant Id)
Request Body schema: application/json
required
user_id
required
string (User Id)
username
required
string (Username) [ 1 .. 128 ] characters
email
required
string <email> (Email)
tenant_id
required
string (Tenant Id)
is_disabled
boolean (Is Disabled)
Default: false
is_verified
boolean (Is Verified)
Default: false
created_at
string <date-time> (Created At)
Updated At (string) or Updated At (null) (Updated At)
Locale (string) or Locale (null) (Locale)
Array of Roles (strings) or Roles (null) (Roles)
External Id (string) or External Id (null) (External Id)

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "username": "string",
  • "email": "user@example.com",
  • "tenant_id": "string",
  • "is_disabled": false,
  • "is_verified": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "locale": "string",
  • "roles": [
    ],
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "user_id": "string",
  • "username": "string",
  • "email": "user@example.com",
  • "tenant_id": "string",
  • "is_disabled": false,
  • "is_verified": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "locale": "string",
  • "roles": [
    ],
  • "external_id": "string"
}

Delete User

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
user_id
required
string (User Id)
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Create User

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
Request Body schema: application/json
required
user_id
required
string (User Id)
username
required
string (Username) [ 1 .. 128 ] characters
email
required
string <email> (Email)
tenant_id
required
string (Tenant Id)
is_disabled
boolean (Is Disabled)
Default: false
is_verified
boolean (Is Verified)
Default: false
created_at
string <date-time> (Created At)
Updated At (string) or Updated At (null) (Updated At)
Locale (string) or Locale (null) (Locale)
Array of Roles (strings) or Roles (null) (Roles)
External Id (string) or External Id (null) (External Id)

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "username": "string",
  • "email": "user@example.com",
  • "tenant_id": "string",
  • "is_disabled": false,
  • "is_verified": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "locale": "string",
  • "roles": [
    ],
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "user_id": "string",
  • "username": "string",
  • "email": "user@example.com",
  • "tenant_id": "string",
  • "is_disabled": false,
  • "is_verified": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "locale": "string",
  • "roles": [
    ],
  • "external_id": "string"
}

Batch Create User

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
Request Body schema: application/json
required
required
Array of objects (Users)
Array
user_id
required
string (User Id)
username
required
string (Username) [ 1 .. 128 ] characters
email
required
string <email> (Email)
tenant_id
required
string (Tenant Id)
is_disabled
boolean (Is Disabled)
Default: false
is_verified
boolean (Is Verified)
Default: false
created_at
string <date-time> (Created At)
Updated At (string) or Updated At (null) (Updated At)
Locale (string) or Locale (null) (Locale)
Array of Roles (strings) or Roles (null) (Roles)
External Id (string) or External Id (null) (External Id)

Responses

Request samples

Content type
application/json
{
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "success_created_count": 0,
  • "fail_create_usernames": [
    ],
  • "duplicate_usernames": [
    ]
}

Batch Delete User

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
Request Body schema: application/json
required
users_ids
required
Array of strings (Users Ids)

Responses

Request samples

Content type
application/json
{
  • "users_ids": [
    ]
}

Response samples

Content type
application/json
null

Create User Key

Authorizations:
APIKeyHeaderHTTPBearer
Request Body schema: application/json
required
name
required
string (Name)
scopes
required
Array of strings (Scopes)
tenant_id
required
string (Tenant Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "scopes": [
    ],
  • "tenant_id": "string"
}

Response samples

Content type
application/json
{
  • "key_id": "string",
  • "key_hash": "string",
  • "user_id": "string",
  • "tenant_id": "string",
  • "created_at": {
    },
  • "name": "",
  • "scopes": [
    ],
  • "last_use_at": {
    },
  • "is_active": true,
  • "api_key": "string"
}

List User Keys

Authorizations:
APIKeyHeaderHTTPBearer

Responses

Response samples

Content type
application/json
{
  • "api_keys": [
    ]
}

Delete Api Key

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
key_id
required
string (Key Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Regenerate Api Key

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
key_id
required
string (Key Id)

Responses

Response samples

Content type
application/json
{
  • "key_id": "string",
  • "key_hash": "string",
  • "user_id": "string",
  • "tenant_id": "string",
  • "created_at": {
    },
  • "name": "",
  • "scopes": [
    ],
  • "last_use_at": {
    },
  • "is_active": true,
  • "api_key": "string"
}

List User Passkeys

Authorizations:
APIKeyHeaderHTTPBearer

Responses

Response samples

Content type
application/json
{
  • "passkeys": [
    ]
}

Delete Passkey

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
key_id
required
string (Key Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Update Passkey

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
key_id
required
string (Key Id)
Request Body schema: application/json
required
name
required
string (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
null

Update Email

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
user_id
required
string (User Id)
tenant_id
required
string (Tenant Id)
Request Body schema: application/json
required
challenge_id
required
string (Challenge Id)
challenge_data
required
string (Challenge Data)
email
required
string (Email)

Responses

Request samples

Content type
application/json
{
  • "challenge_id": "string",
  • "challenge_data": "string",
  • "email": "string"
}

Response samples

Content type
application/json
null

Client

Read Clients

Authorizations:
APIKeyHeaderHTTPBearer
query Parameters
tenant_id
required
string (Tenant Id)
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100

Responses

Response samples

Content type
application/json
{
  • "clients": [
    ]
}

Create Client

Authorizations:
APIKeyHeaderHTTPBearer
Request Body schema: application/json
required
client_id
required
string (Client Id)
name
required
string (Name)
tenant_id
required
string (Tenant Id)
redirect_uris
Array of strings (Redirect Uris)
post_logout_redirect_uri
Array of strings (Post Logout Redirect Uri)
allowed_scopes
Array of strings (Allowed Scopes)
token_endpoint_auth_method
string (Token Endpoint Auth Method)
Default: "client_secret_post"
Value: "client_secret_post"
Logo Uri (string) or Logo Uri (null) (Logo Uri)
Op Policy Url (string) or Op Policy Url (null) (Op Policy Url)
Op Tos Url (string) or Op Tos Url (null) (Op Tos Url)
Op User Agreement Url (string) or Op User Agreement Url (null) (Op User Agreement Url)
Client Uri (string) or Client Uri (null) (Client Uri)
Client Logout Uri (string) or Client Logout Uri (null) (Client Logout Uri)
register_enable
boolean (Register Enable)
Default: false
Tenant Name (string) or Tenant Name (null) (Tenant Name)
Client Secret (string) or Client Secret (null) (Client Secret)
client_type
string (ClientType)
Default: "confidential"
Enum: "public" "confidential"
is_lock
boolean (Is Lock)
Default: false
sing_alg
string (AvailableSingAlg)
Default: "EdDSA"
Enum: "RS256" "EdDSA"
ClientFlow (object) or null

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "name": "string",
  • "tenant_id": "string",
  • "redirect_uris": [
    ],
  • "post_logout_redirect_uri": [
    ],
  • "allowed_scopes": [
    ],
  • "token_endpoint_auth_method": "client_secret_post",
  • "logo_uri": "string",
  • "op_policy_url": "string",
  • "op_tos_url": "string",
  • "op_user_agreement_url": "string",
  • "client_uri": "string",
  • "client_logout_uri": "string",
  • "register_enable": false,
  • "tenant_name": "string",
  • "client_secret": "string",
  • "client_type": "public",
  • "is_lock": false,
  • "sing_alg": "RS256",
  • "flow": {
    }
}

Response samples

Content type
application/json
{
  • "client_id": "string",
  • "name": "string",
  • "tenant_id": "string",
  • "redirect_uris": [
    ],
  • "post_logout_redirect_uri": [
    ],
  • "allowed_scopes": [
    ],
  • "token_endpoint_auth_method": "client_secret_post",
  • "logo_uri": "string",
  • "op_policy_url": "string",
  • "op_tos_url": "string",
  • "op_user_agreement_url": "string",
  • "client_uri": "string",
  • "client_logout_uri": "string",
  • "register_enable": false,
  • "tenant_name": "string",
  • "client_secret": "string",
  • "client_type": "public",
  • "is_lock": false,
  • "sing_alg": "RS256",
  • "flow": {
    }
}

Read Client

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
client_id
required
string (Client Id)
query Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
null

Update Client

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
client_id
required
string (Client Id)
Request Body schema: application/json
required
client_id
required
string (Client Id)
name
required
string (Name)
tenant_id
required
string (Tenant Id)
redirect_uris
Array of strings (Redirect Uris)
post_logout_redirect_uri
Array of strings (Post Logout Redirect Uri)
allowed_scopes
Array of strings (Allowed Scopes)
token_endpoint_auth_method
string (Token Endpoint Auth Method)
Default: "client_secret_post"
Value: "client_secret_post"
Logo Uri (string) or Logo Uri (null) (Logo Uri)
Op Policy Url (string) or Op Policy Url (null) (Op Policy Url)
Op Tos Url (string) or Op Tos Url (null) (Op Tos Url)
Op User Agreement Url (string) or Op User Agreement Url (null) (Op User Agreement Url)
Client Uri (string) or Client Uri (null) (Client Uri)
Client Logout Uri (string) or Client Logout Uri (null) (Client Logout Uri)
register_enable
boolean (Register Enable)
Default: false
Tenant Name (string) or Tenant Name (null) (Tenant Name)
Client Secret (string) or Client Secret (null) (Client Secret)
client_type
string (ClientType)
Default: "confidential"
Enum: "public" "confidential"
is_lock
boolean (Is Lock)
Default: false
sing_alg
string (AvailableSingAlg)
Default: "EdDSA"
Enum: "RS256" "EdDSA"
ClientFlow (object) or null

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "name": "string",
  • "tenant_id": "string",
  • "redirect_uris": [
    ],
  • "post_logout_redirect_uri": [
    ],
  • "allowed_scopes": [
    ],
  • "token_endpoint_auth_method": "client_secret_post",
  • "logo_uri": "string",
  • "op_policy_url": "string",
  • "op_tos_url": "string",
  • "op_user_agreement_url": "string",
  • "client_uri": "string",
  • "client_logout_uri": "string",
  • "register_enable": false,
  • "tenant_name": "string",
  • "client_secret": "string",
  • "client_type": "public",
  • "is_lock": false,
  • "sing_alg": "RS256",
  • "flow": {
    }
}

Response samples

Content type
application/json
null

Delete Client

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
client_id
required
string (Client Id)
query Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
null

Regenerate Secret

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
client_id
required
string (Client Id)

Responses

Response samples

Content type
application/json
null

Api Keys

Create User Key

Authorizations:
APIKeyHeaderHTTPBearer
Request Body schema: application/json
required
name
required
string (Name)
scopes
required
Array of strings (Scopes)
tenant_id
required
string (Tenant Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "scopes": [
    ],
  • "tenant_id": "string"
}

Response samples

Content type
application/json
{
  • "key_id": "string",
  • "key_hash": "string",
  • "user_id": "string",
  • "tenant_id": "string",
  • "created_at": {
    },
  • "name": "",
  • "scopes": [
    ],
  • "last_use_at": {
    },
  • "is_active": true,
  • "api_key": "string"
}

List User Keys

Authorizations:
APIKeyHeaderHTTPBearer
query Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
{
  • "api_keys": [
    ]
}

Delete Api Key

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
key_id
required
string (Key Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Regenerate Api Key

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
key_id
required
string (Key Id)

Responses

Response samples

Content type
application/json
{
  • "key_id": "string",
  • "key_hash": "string",
  • "user_id": "string",
  • "tenant_id": "string",
  • "created_at": {
    },
  • "name": "",
  • "scopes": [
    ],
  • "last_use_at": {
    },
  • "is_active": true,
  • "api_key": "string"
}

Get Keys Scopes

Authorizations:
APIKeyHeaderHTTPBearer

Responses

Response samples

Content type
application/json
{
  • "scopes": [
    ],
  • "tenants": [
    ]
}

Tenants

Read Tenants

Authorizations:
APIKeyHeaderHTTPBearer

Responses

Response samples

Content type
application/json
{
  • "tenants": [
    ]
}

Create Tenant

Authorizations:
APIKeyHeaderHTTPBearer
Request Body schema: application/json
required
tenant_id
required
string (Tenant Id)
register_enable
boolean (Register Enable)
Default: false
is_2fa
boolean (Is 2Fa)
Default: false
use_pin
boolean (Use Pin)
Default: true
pin_size
integer (Pin Size)
Default: 6
use_pattern
boolean (Use Pattern)
Default: true
patter_size
integer (Patter Size)
Default: 3
use_face_recognition
boolean (Use Face Recognition)
Default: false
use_liveness
boolean (Use Liveness)
Default: false
display_name
string (Display Name)
Default: ""
show_pin_when_typing
boolean (Show Pin When Typing)
Default: true
object (BlockConfig)
login_order
Array of strings (Login Order)
Items Enum: "PIN" "PATTERN"
passkey_enabled
boolean (Passkey Enabled)
Default: false
has_username_and_email
boolean (Has Username And Email)
Default: true
LivenessConfig (object) or null

Responses

Request samples

Content type
application/json
{
  • "tenant_id": "string",
  • "register_enable": false,
  • "is_2fa": false,
  • "use_pin": true,
  • "pin_size": 6,
  • "use_pattern": true,
  • "patter_size": 3,
  • "use_face_recognition": false,
  • "use_liveness": false,
  • "display_name": "",
  • "show_pin_when_typing": true,
  • "block_config": {
    },
  • "login_order": [
    ],
  • "passkey_enabled": false,
  • "has_username_and_email": true,
  • "liveness_config": {
    }
}

Response samples

Content type
application/json
null

Blocked Ips

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
query Parameters
page
integer (Page) >= 0
Default: 0
page_size
integer (Page Size) ( 0 .. 500 ]
Default: 100
sort_direction
integer (Sort Direction) [ -1 .. 1 ]
Default: -1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": true,
  • "total_count": 0
}

Del Blocked Ip

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
query Parameters
ip
required
string (Ip) [ 7 .. 15 ] characters

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Block Users

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
query Parameters
page
integer (Page) >= 0
Default: 0
page_size
integer (Page Size) ( 0 .. 500 ]
Default: 100
sort_direction
integer (Sort Direction) [ -1 .. 1 ]
Default: -1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": true,
  • "total_count": 0
}

Del Block Users

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
query Parameters
username
required
string (Username) non-empty

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Read Tenant

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
{
  • "tenant_id": "string",
  • "register_enable": false,
  • "is_2fa": false,
  • "use_pin": true,
  • "pin_size": 6,
  • "use_pattern": true,
  • "patter_size": 3,
  • "use_face_recognition": false,
  • "use_liveness": false,
  • "display_name": "",
  • "show_pin_when_typing": true,
  • "block_config": {
    },
  • "login_order": [
    ],
  • "passkey_enabled": false,
  • "has_username_and_email": true,
  • "liveness_config": {
    }
}

Update Tenant

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
Request Body schema: application/json
required
register_enable
boolean (Register Enable)
Default: false
use_pin
boolean (Use Pin)
Default: true
pin_size
integer (Pin Size)
Default: 6
use_pattern
boolean (Use Pattern)
Default: true
patter_size
integer (Patter Size)
Default: 3
use_face_recognition
boolean (Use Face Recognition)
Default: false
use_liveness
boolean (Use Liveness)
Default: false
show_pin_when_typing
boolean (Show Pin When Typing)
Default: true
display_name
required
string (Display Name)
BlockConfig (object) or null
Array of Login Order (strings) or Login Order (null) (Login Order)
passkey_enabled
boolean (Passkey Enabled)
Default: false
has_username_and_email
boolean (Has Username And Email)
Default: true
LivenessConfig (object) or null

Responses

Request samples

Content type
application/json
{
  • "register_enable": false,
  • "use_pin": true,
  • "pin_size": 6,
  • "use_pattern": true,
  • "patter_size": 3,
  • "use_face_recognition": false,
  • "use_liveness": false,
  • "show_pin_when_typing": true,
  • "display_name": "string",
  • "block_config": {
    },
  • "login_order": [
    ],
  • "passkey_enabled": false,
  • "has_username_and_email": true,
  • "liveness_config": {
    }
}

Response samples

Content type
application/json
null

Delete Tenant

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Blocker

Blocked Ips

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
query Parameters
page
integer (Page) >= 0
Default: 0
page_size
integer (Page Size) ( 0 .. 500 ]
Default: 100
sort_direction
integer (Sort Direction) [ -1 .. 1 ]
Default: -1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": true,
  • "total_count": 0
}

Del Blocked Ip

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
query Parameters
ip
required
string (Ip) [ 7 .. 15 ] characters

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Block Users

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
query Parameters
page
integer (Page) >= 0
Default: 0
page_size
integer (Page Size) ( 0 .. 500 ]
Default: 100
sort_direction
integer (Sort Direction) [ -1 .. 1 ]
Default: -1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": true,
  • "total_count": 0
}

Del Block Users

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
query Parameters
username
required
string (Username) non-empty

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

SCIM-2.0

Get Scim Service Provider Config

path Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
{ }

Get Scim Schemas

path Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
{ }

Get Resource Types

path Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
{ }

Get Resource Type

path Parameters
tenant_id
required
string (Tenant Id)
resource_type_id
required
string (Resource Type Id)

Responses

Response samples

Content type
application/json
{ }

Get Scim Schema

path Parameters
schema_uri
required
string (Schema Uri)
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
{ }

Create Scim User

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List Scim Users

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
query Parameters
startIndex
integer (Startindex) >= 1
Default: 1
count
integer (Count) [ 0 .. 100 ]
Default: 100
Filter (string) or Filter (null) (Filter)

Responses

Response samples

Content type
application/json
{ }

Replace Scim User

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
user_id
required
string (User Id)
Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Get Scim User

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
user_id
required
string (User Id)
query Parameters
Attributes (string) or Attributes (null) (Attributes)
Excludedattributes (string) or Excludedattributes (null) (Excludedattributes)

Responses

Response samples

Content type
application/json
{ }

Delete Scim User

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
user_id
required
string (User Id)

Responses

Response samples

Content type
application/json
{ }

Patch Scim User

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
user_id
required
string (User Id)
Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Get Scim User

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
user_id
required
string (User Id)
query Parameters
Attributes (string) or Attributes (null) (Attributes)
Excludedattributes (string) or Excludedattributes (null) (Excludedattributes)

Responses

Response samples

Content type
application/json
{ }

Create Scim Group

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

List Scim Group

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
query Parameters
startIndex
integer (Startindex) >= 1
Default: 1
count
integer (Count) [ 0 .. 100 ]
Default: 100
Filter (string) or Filter (null) (Filter)

Responses

Response samples

Content type
application/json
{ }

Replace Scim Group

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
group_id
required
string (Group Id)
Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Patch Scim Group

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
group_id
required
string (Group Id)
Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Get Scim Group

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
group_id
required
string (Group Id)
query Parameters
Attributes (string) or Attributes (null) (Attributes)
Excludedattributes (string) or Excludedattributes (null) (Excludedattributes)

Responses

Response samples

Content type
application/json
{ }

Delete Scim Group

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
group_id
required
string (Group Id)

Responses

Response samples

Content type
application/json
{ }

Get Scim Group

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)
group_id
required
string (Group Id)
query Parameters
Attributes (string) or Attributes (null) (Attributes)
Excludedattributes (string) or Excludedattributes (null) (Excludedattributes)

Responses

Response samples

Content type
application/json
{ }

Me Data

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
{ }

Me Data

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
{ }

Me Data

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
{ }

Me Data

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
{ }

Me Data

Authorizations:
APIKeyHeaderHTTPBearer
path Parameters
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
{ }

Catch All Scim Routes

path Parameters
path
required
string (Path)
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
{ }

Catch All Scim Routes

path Parameters
path
required
string (Path)
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
{ }

Catch All Scim Routes

path Parameters
path
required
string (Path)
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
{ }

Catch All Scim Routes

path Parameters
path
required
string (Path)
tenant_id
required
string (Tenant Id)

Responses

Response samples

Content type
application/json
{ }

Passkey

Register Options

Authorizations:
APIKeyHeaderHTTPBearer

Responses

Response samples

Content type
application/json
null

Verify Registration

Authorizations:
APIKeyHeaderHTTPBearer
Request Body schema: application/json
required
id
required
string (Id)
raw_id
required
string (Raw Id)
client_data_json
required
string (Client Data Json)
attestation_object
required
string (Attestation Object)
Array of Transports (strings) or Transports (null) (Transports)
AuthenticatorAttachment (string) or null
Name (string) or Name (null) (Name)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "raw_id": "string",
  • "client_data_json": "string",
  • "attestation_object": "string",
  • "transports": [
    ],
  • "authenticator_attachment": "platform",
  • "name": "string"
}

Response samples

Content type
application/json
null

Auth Options

query Parameters
tenant_id
required
string (Tenant Id)
Request Body schema: application/json
required
username
required
string (Username)
tenant_id
required
string (Tenant Id)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "tenant_id": "string"
}

Response samples

Content type
application/json
null

Verify Auth

query Parameters
Auth Req Id (string) or Auth Req Id (null) (Auth Req Id)
Request Body schema: application/json
required
id
required
string (Id)
raw_id
required
string (Raw Id)
client_data_json
required
string (Client Data Json)
authenticator_data
required
string (Authenticator Data)
signature
required
string (Signature)
username
required
string (Username)
tenant_id
required
string (Tenant Id)
User Handle (string) or User Handle (null) (User Handle)
AuthenticatorAttachment (string) or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "raw_id": "string",
  • "client_data_json": "string",
  • "authenticator_data": "string",
  • "signature": "string",
  • "username": "string",
  • "tenant_id": "string",
  • "user_handle": "string",
  • "authenticator_attachment": "platform"
}

Response samples

Content type
application/json
{
  • "nonce": "string",
  • "need_verify": false
}

Analytics

Liveness Report

Authorizations:
APIKeyHeaderHTTPBearer
query Parameters
start
required
string (Start)
end
required
string (End)
tenant_id
required
string (Tenant Id)
resolution
string (Resolution) ^(day|hour|minute)$
Default: "day"

Responses

Response samples

Content type
application/json
null

Webauthn Config

Responses

Response samples

Content type
application/json
null