API specs

• Authentication
  • postRegister
  • postGet Challenge
  • postAuthenticate
  • getSign In
  • postLogout
  • postRevoke Session
  • postRevoke All Session
  • getList Sessions
  • getVerify Email
  • getGet Client
  • getGet Client Tenant
  • postRequest Reset Password
  • postReset Password Code
  • postChange Password
• OIDC
  • getAuthorize
  • postToken Exchange
  • getUserinfo
  • postRevoke
  • getGet Jwks
  • getGet Openid Configuration
  • getAuthorize
  • postToken Exchange
  • getGet Jwks Standard
  • getGet Openid Configuration Standard
  • getAuthorize Standard
  • postToken Exchange Standard
• OIDC special flows
  • getGet Jwks Standard
  • getGet Openid Configuration Standard
  • postAuthorize Mmfa
  • getMicrosoft-Mfa-Form
• health
  • getHealth
• User
  • getGet Current User
  • getList Users
  • getGet User By Name
  • getGet User
  • putUpdate User
  • delDelete User
  • postCreate User
  • postBatch Create User
  • postBatch Delete User
  • postCreate User Key
  • getList User Keys
  • delDelete Api Key
  • postRegenerate Api Key
• Client
  • getRead Clients
  • postCreate Client
  • getRead Client
  • putUpdate Client
  • delDelete Client
• Api Keys
  • postCreate User Key
  • getList User Keys
  • delDelete Api Key
  • postRegenerate Api Key
  • getGet Keys Scopes
• Tenants
  • getRead Tenants
  • postCreate Tenant
  • getRead Tenant
  • patchUpdate Tenant
  • delDelete Tenant

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)

Responses

http://docs.secretsvault.net/api/auth/register

Request samples

• Payload

Content type

application/json

{

• "username": "string",
• "email": "user@example.com",
• "encrypted_commitment": "string",
• "proto_version": "string"

}

Response samples

• 201
• 422

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

http://docs.secretsvault.net/api/auth/challenge

Request samples

• Payload

Content type

application/json

{

• "username": "string",
• "cipherKey": "string"

}

Response samples

• 200
• 422

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

Responses

http://docs.secretsvault.net/api/auth/v-login

Request samples

• Payload

Content type

application/json

{

• "username": "string",
• "cipherKey": "string",
• "challenge_id": "string",
• "challenge_data": "string",
• "ber": {

  • "ber": {

    • "count_bits": 0,
    • "error_bits": 0,
    • "BER_PERCENT": "string"

    },
  • "image_dim": [

    • 0,
    • 0

    ],
  • "algorithm_version": "string"

  }

}

Response samples

• 200
• 422

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

http://docs.secretsvault.net/api/auth/sign_in

Response samples

• 200
• 422

Content type

application/json

null

Logout

Authorizations:

APIKeyHeaderHTTPBearer

Responses

http://docs.secretsvault.net/api/auth/logout

Response samples

• 200

Content type

application/json

null

Revoke Session

Authorizations:

APIKeyHeaderHTTPBearer

Request Body schema: application/json

required

session_id required

string (Session Id)

Responses

http://docs.secretsvault.net/api/auth/revoke-session

Request samples

• Payload

Content type

application/json

{

• "session_id": "string"

}

Response samples

• 200
• 422

Content type

application/json

{

• "session_id": "string"

}

Revoke All Session

Authorizations:

APIKeyHeaderHTTPBearer

Responses

http://docs.secretsvault.net/api/auth/revoke-all-session

Response samples

• 200

Content type

application/json

null

List Sessions

Authorizations:

APIKeyHeaderHTTPBearer

Responses

http://docs.secretsvault.net/api/auth/list-session

Response samples

• 200

Content type

application/json

{

• "sessions": [

  • {

    • "session_id": "string",
    • "user_id": "string",
    • "tenant_id": "string",
    • "created": {

      • "at": "2019-08-24T14:15:22Z",
      • "ip": "string",
      • "country": "string",
      • "user_agent": "string",
      • "user_agent_parsed": {

        • "browser": {

          • "family": "string",
          • "version": "string"

          },
        • "os": {

          • "family": "string",
          • "version": "string"

          },
        • "device": {

          • "family": "string",
          • "brand": "string",
          • "model": "string"

          },
        • "is_mobile": false,
        • "is_tablet": false,
        • "is_pc": false,
        • "is_bot": false

        }

      },
    • "expires_at": "2019-08-24T14:15:22Z",
    • "token_issue": {

      • "at": "2019-08-24T14:15:22Z",
      • "ip": "string",
      • "country": "string",
      • "user_agent": "string",
      • "user_agent_parsed": {

        • "browser": {

          • "family": "string",
          • "version": "string"

          },
        • "os": {

          • "family": "string",
          • "version": "string"

          },
        • "device": {

          • "family": "string",
          • "brand": "string",
          • "model": "string"

          },
        • "is_mobile": false,
        • "is_tablet": false,
        • "is_pc": false,
        • "is_bot": false

        }

      },
    • "last_access": {

      • "at": "2019-08-24T14:15:22Z",
      • "ip": "string",
      • "country": "string",
      • "user_agent": "string",
      • "user_agent_parsed": {

        • "browser": {

          • "family": "string",
          • "version": "string"

          },
        • "os": {

          • "family": "string",
          • "version": "string"

          },
        • "device": {

          • "family": "string",
          • "brand": "string",
          • "model": "string"

          },
        • "is_mobile": false,
        • "is_tablet": false,
        • "is_pc": false,
        • "is_bot": false

        }

      }

    }

  ],
• "total": 0

}

Verify Email

query Parameters

code required

string (Code)

Responses

http://docs.secretsvault.net/api/auth/verify-email

Response samples

• 200
• 422

Content type

application/json

null

Get Client

query Parameters

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

Responses

http://docs.secretsvault.net/api/auth/client

Response samples

• 200
• 422

Content type

application/json

{

• "client_id": "string",
• "name": "string",
• "tenant_id": "string",
• "redirect_uris": { },
• "allowed_scopes": [

  • "string"

  ],
• "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"

}

Get Client Tenant

query Parameters

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

Responses

http://docs.secretsvault.net/api/auth/client-tenant

Response samples

• 200
• 422

Content type

application/json

{

• "client": {

  • "client_id": "string",
  • "name": "string",
  • "tenant_id": "string",
  • "redirect_uris": { },
  • "allowed_scopes": [

    • "string"

    ],
  • "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"

  },
• "tenant": {

  • "tenant_id": "string",
  • "register_enable": false,
  • "is_2fa": false,
  • "use_pin": true,
  • "use_face_recognition": false,
  • "display_name": ""

  }

}

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

http://docs.secretsvault.net/api/auth/request-reset-password

Request samples

• Payload

Content type

application/json

{

• "username": "string",
• "email": "string"

}

Response samples

• 200
• 422

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)

Responses

http://docs.secretsvault.net/api/auth/reset-password-code

Request samples

• Payload

Content type

application/json

{

• "code": "string",
• "username": "string",
• "encrypted_commitment": "string",
• "proto_version": "string"

}

Response samples

• 200
• 422

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)

Responses

http://docs.secretsvault.net/api/auth/change-password

Request samples

• Payload

Content type

application/json

{

• "encrypted_commitment": "string",
• "proto_version": "string"

}

Response samples

• 200
• 422

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

http://docs.secretsvault.net/api/authorize

Response samples

• 200
• 422

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

http://docs.secretsvault.net/api/token

Response samples

• 200
• 422

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

http://docs.secretsvault.net/api/userinfo

Response samples

• 200

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

http://docs.secretsvault.net/api/revoke

Response samples

• 200
• 422

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

http://docs.secretsvault.net/api/oidc/.well-known/jwks/{tenant_id}

Response samples

• 200
• 422

Content type

application/json

null

Get Openid Configuration

Return the OpenID Connect configuration.

path Parameters

tenant_id required

string (Tenant Id)

Responses

http://docs.secretsvault.net/api/oidc/.well-known/openid-configuration/{tenant_id}

Response samples

• 200
• 422

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

http://docs.secretsvault.net/api/oidc/authorize/{tenant_id}

Response samples

• 200
• 422

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

http://docs.secretsvault.net/api/oidc/token/{tenant_id}

Response samples

• 200
• 422

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

http://docs.secretsvault.net/api/oidc/{tenant_id}/.well-known/jwks

Response samples

• 200
• 422

Content type

application/json

null

Get Openid Configuration Standard

Return the OpenID Connect configuration.

path Parameters

tenant_id required

string (Tenant Id)

Responses

http://docs.secretsvault.net/api/oidc/{tenant_id}/.well-known/openid-configuration

Response samples

• 200
• 422

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

http://docs.secretsvault.net/api/oidc/{tenant_id}/authorize

Response samples

• 200
• 422

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

http://docs.secretsvault.net/api/oidc/{tenant_id}/token

Response samples

• 200
• 422

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

http://docs.secretsvault.net/api/flow/microsoft-mfa/{tenant_id}/.well-known/jwks

Response samples

• 200
• 422

Content type

application/json

null

Get Openid Configuration Standard

Return the OpenID Connect configuration.

path Parameters

tenant_id required

string (Tenant Id)

Responses

http://docs.secretsvault.net/api/flow/microsoft-mfa/{tenant_id}/.well-known/openid-configuration

Response samples

• 200
• 422

Content type

application/json

null

Authorize Mmfa

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

http://docs.secretsvault.net/api/flow/microsoft-mfa/{tenant_id}/authorize

Response samples

• 200
• 422

Content type

application/json

null

Microsoft-Mfa-Form

path Parameters

flow_id required

string (Flow Id)

Responses

http://docs.secretsvault.net/api/flow/microsoft-mfa/submit/{flow_id}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

health

Health

Responses

http://docs.secretsvault.net/api/health

Response samples

• 200

Content type

application/json

{

• "status": "string",
• "version": "string",
• "db_status": "string",
• "env": "string"

}

User

Get Current User

Authorizations:

APIKeyHeaderHTTPBearer

Responses

http://docs.secretsvault.net/api/users/me

Response samples

• 200

Content type

application/json

{

• "user_id": "string",
• "username": "string",
• "email": "string",
• "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": [

  • "string"

  ]

}

List Users

Authorizations:

APIKeyHeaderHTTPBearer

path Parameters

tenant_id required

string (Tenant Id)

query Parameters

username	string (Username) Default: ""
email	string (Email) Default: ""
limit	integer (Limit) Default: 10
offset	integer (Offset) Default: 0

Responses

http://docs.secretsvault.net/api/users/list/{tenant_id}

Response samples

• 200
• 422

Content type

application/json

{

• "data": [

  • {

    • "user_id": "string",
    • "username": "string",
    • "email": "string",
    • "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": [

      • "string"

      ]

    }

  ],
• "has_next": true,
• "total_count": 0

}

Get User By Name

Authorizations:

APIKeyHeaderHTTPBearer

path Parameters

tenant_id required	string (Tenant Id)
username required	string (Username)

Responses

http://docs.secretsvault.net/api/users/user/t/{tenant_id}/u/{username}

Response samples

• 200
• 422

Content type

application/json

{

• "user_id": "string",
• "username": "string",
• "email": "string",
• "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": [

  • "string"

  ]

}

Get User

Authorizations:

APIKeyHeaderHTTPBearer

path Parameters

tenant_id required	string (Tenant Id)
user_id required	string (User Id)

Responses

http://docs.secretsvault.net/api/users/user/t/{tenant_id}/i/{user_id}

Response samples

• 200
• 422

Content type

application/json

{

• "user_id": "string",
• "username": "string",
• "email": "string",
• "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": [

  • "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)
email required	string (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)

Responses

http://docs.secretsvault.net/api/users/user/t/{tenant_id}/i/{user_id}

Request samples

• Payload

Content type

application/json

{

• "user_id": "string",
• "username": "string",
• "email": "string",
• "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": [

  • "string"

  ]

}

Response samples

• 200
• 422

Content type

application/json

{

• "user_id": "string",
• "username": "string",
• "email": "string",
• "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": [

  • "string"

  ]

}

Delete User

Authorizations:

APIKeyHeaderHTTPBearer

path Parameters

user_id required	string (User Id)
tenant_id required	string (Tenant Id)

Responses

http://docs.secretsvault.net/api/users/user/t/{tenant_id}/i/{user_id}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

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)
email required	string (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)

Responses

http://docs.secretsvault.net/api/users/user/{tenant_id}

Request samples

• Payload

Content type

application/json

{

• "user_id": "string",
• "username": "string",
• "email": "string",
• "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": [

  • "string"

  ]

}

Response samples

• 201
• 422

Content type

application/json

{

• "user_id": "string",
• "username": "string",
• "email": "string",
• "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": [

  • "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) email required string (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)

Responses

http://docs.secretsvault.net/api/users/batch/user/{tenant_id}

Request samples

• Payload

Content type

application/json

{

• "users": [

  • {

    • "user_id": "string",
    • "username": "string",
    • "email": "string",
    • "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": [

      • "string"

      ]

    }

  ]

}

Response samples

• 201
• 422

Content type

application/json

{

• "success_created_count": 0,
• "fail_create_usernames": [

  • "string"

  ],
• "duplicate_usernames": [

  • "string"

  ]

}

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

http://docs.secretsvault.net/api/users/batch/delete/{tenant_id}

Request samples

• Payload

Content type

application/json

{

• "users_ids": [

  • "string"

  ]

}

Response samples

• 201
• 422

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

http://docs.secretsvault.net/api/users/key

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "scopes": [

  • "string"

  ],
• "tenant_id": "string"

}

Response samples

• 201
• 422

Content type

application/json

{

• "key_id": "string",
• "key_hash": "string",
• "user_id": "string",
• "tenant_id": "string",
• "created_at": {

  • "at": "2019-08-24T14:15:22Z",
  • "ip": "string",
  • "country": "string",
  • "user_agent": "string",
  • "user_agent_parsed": {

    • "browser": {

      • "family": "string",
      • "version": "string"

      },
    • "os": {

      • "family": "string",
      • "version": "string"

      },
    • "device": {

      • "family": "string",
      • "brand": "string",
      • "model": "string"

      },
    • "is_mobile": false,
    • "is_tablet": false,
    • "is_pc": false,
    • "is_bot": false

    }

  },
• "name": "",
• "scopes": [

  • "string"

  ],
• "last_use_at": {

  • "at": "2019-08-24T14:15:22Z",
  • "ip": "string",
  • "country": "string",
  • "user_agent": "string",
  • "user_agent_parsed": {

    • "browser": {

      • "family": "string",
      • "version": "string"

      },
    • "os": {

      • "family": "string",
      • "version": "string"

      },
    • "device": {

      • "family": "string",
      • "brand": "string",
      • "model": "string"

      },
    • "is_mobile": false,
    • "is_tablet": false,
    • "is_pc": false,
    • "is_bot": false

    }

  },
• "is_active": true,
• "api_key": "string"

}

List User Keys

Authorizations:

APIKeyHeaderHTTPBearer

Responses

http://docs.secretsvault.net/api/users/keys

Response samples

• 200

Content type

application/json

{

• "api_keys": [

  • {

    • "key_id": "string",
    • "key_hash": "string",
    • "user_id": "string",
    • "tenant_id": "string",
    • "created_at": {

      • "at": "2019-08-24T14:15:22Z",
      • "ip": "string",
      • "country": "string",
      • "user_agent": "string",
      • "user_agent_parsed": {

        • "browser": {

          • "family": "string",
          • "version": "string"

          },
        • "os": {

          • "family": "string",
          • "version": "string"

          },
        • "device": {

          • "family": "string",
          • "brand": "string",
          • "model": "string"

          },
        • "is_mobile": false,
        • "is_tablet": false,
        • "is_pc": false,
        • "is_bot": false

        }

      },
    • "name": "",
    • "scopes": [

      • "string"

      ],
    • "last_use_at": {

      • "at": "2019-08-24T14:15:22Z",
      • "ip": "string",
      • "country": "string",
      • "user_agent": "string",
      • "user_agent_parsed": {

        • "browser": {

          • "family": "string",
          • "version": "string"

          },
        • "os": {

          • "family": "string",
          • "version": "string"

          },
        • "device": {

          • "family": "string",
          • "brand": "string",
          • "model": "string"

          },
        • "is_mobile": false,
        • "is_tablet": false,
        • "is_pc": false,
        • "is_bot": false

        }

      },
    • "is_active": true,
    • "username": ""

    }

  ]

}

Delete Api Key

Authorizations:

APIKeyHeaderHTTPBearer

path Parameters

key_id required

string (Key Id)

Responses

http://docs.secretsvault.net/api/users/key/{key_id}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Regenerate Api Key

Authorizations:

APIKeyHeaderHTTPBearer

path Parameters

key_id required

string (Key Id)

Responses

http://docs.secretsvault.net/api/users/key/{key_id}/regenerate

Response samples

• 200
• 422

Content type

application/json

{

• "key_id": "string",
• "key_hash": "string",
• "user_id": "string",
• "tenant_id": "string",
• "created_at": {

  • "at": "2019-08-24T14:15:22Z",
  • "ip": "string",
  • "country": "string",
  • "user_agent": "string",
  • "user_agent_parsed": {

    • "browser": {

      • "family": "string",
      • "version": "string"

      },
    • "os": {

      • "family": "string",
      • "version": "string"

      },
    • "device": {

      • "family": "string",
      • "brand": "string",
      • "model": "string"

      },
    • "is_mobile": false,
    • "is_tablet": false,
    • "is_pc": false,
    • "is_bot": false

    }

  },
• "name": "",
• "scopes": [

  • "string"

  ],
• "last_use_at": {

  • "at": "2019-08-24T14:15:22Z",
  • "ip": "string",
  • "country": "string",
  • "user_agent": "string",
  • "user_agent_parsed": {

    • "browser": {

      • "family": "string",
      • "version": "string"

      },
    • "os": {

      • "family": "string",
      • "version": "string"

      },
    • "device": {

      • "family": "string",
      • "brand": "string",
      • "model": "string"

      },
    • "is_mobile": false,
    • "is_tablet": false,
    • "is_pc": false,
    • "is_bot": false

    }

  },
• "is_active": true,
• "api_key": "string"

}

Client

Read Clients

Authorizations:

APIKeyHeaderHTTPBearer

query Parameters

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

Responses

http://docs.secretsvault.net/api/clients/list

Response samples

• 200
• 422

Content type

application/json

{

• "clients": [

  • {

    • "client_id": "string",
    • "name": "string",
    • "tenant_id": "string",
    • "redirect_uris": { },
    • "allowed_scopes": [

      • "string"

      ],
    • "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": {

      • "type": "microsoft-mfa",
      • "issuer": "string"

      }

    }

  ]

}

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) Default: []
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

http://docs.secretsvault.net/api/clients/client

Request samples

• Payload

Content type

application/json

{

• "client_id": "string",
• "name": "string",
• "tenant_id": "string",
• "redirect_uris": { },
• "allowed_scopes": [

  • "string"

  ],
• "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": {

  • "type": "microsoft-mfa",
  • "issuer": "string"

  }

}

Response samples

• 200
• 422

Content type

application/json

{

• "client_id": "string",
• "name": "string",
• "tenant_id": "string",
• "redirect_uris": { },
• "allowed_scopes": [

  • "string"

  ],
• "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": {

  • "type": "microsoft-mfa",
  • "issuer": "string"

  }

}

Read Client

Authorizations:

APIKeyHeaderHTTPBearer

path Parameters

client_id required

string (Client Id)

query Parameters

tenant_id required

string (Tenant Id)

Responses

http://docs.secretsvault.net/api/clients/client/{client_id}

Response samples

• 200
• 422

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) Default: []
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

http://docs.secretsvault.net/api/clients/client/{client_id}

Request samples

• Payload

Content type

application/json

{

• "client_id": "string",
• "name": "string",
• "tenant_id": "string",
• "redirect_uris": { },
• "allowed_scopes": [

  • "string"

  ],
• "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": {

  • "type": "microsoft-mfa",
  • "issuer": "string"

  }

}

Response samples

• 200
• 422

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

http://docs.secretsvault.net/api/clients/client/{client_id}

Response samples

• 200
• 422

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

http://docs.secretsvault.net/api/api-keys/key

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "scopes": [

  • "string"

  ],
• "tenant_id": "string"

}

Response samples

• 201
• 422

Content type

application/json

{

• "key_id": "string",
• "key_hash": "string",
• "user_id": "string",
• "tenant_id": "string",
• "created_at": {

  • "at": "2019-08-24T14:15:22Z",
  • "ip": "string",
  • "country": "string",
  • "user_agent": "string",
  • "user_agent_parsed": {

    • "browser": {

      • "family": "string",
      • "version": "string"

      },
    • "os": {

      • "family": "string",
      • "version": "string"

      },
    • "device": {

      • "family": "string",
      • "brand": "string",
      • "model": "string"

      },
    • "is_mobile": false,
    • "is_tablet": false,
    • "is_pc": false,
    • "is_bot": false

    }

  },
• "name": "",
• "scopes": [

  • "string"

  ],
• "last_use_at": {

  • "at": "2019-08-24T14:15:22Z",
  • "ip": "string",
  • "country": "string",
  • "user_agent": "string",
  • "user_agent_parsed": {

    • "browser": {

      • "family": "string",
      • "version": "string"

      },
    • "os": {

      • "family": "string",
      • "version": "string"

      },
    • "device": {

      • "family": "string",
      • "brand": "string",
      • "model": "string"

      },
    • "is_mobile": false,
    • "is_tablet": false,
    • "is_pc": false,
    • "is_bot": false

    }

  },
• "is_active": true,
• "api_key": "string"

}

List User Keys

Authorizations:

APIKeyHeaderHTTPBearer

query Parameters

tenant_id required

string (Tenant Id)

Responses

http://docs.secretsvault.net/api/api-keys/keys

Response samples

• 200
• 422

Content type

application/json

{

• "api_keys": [

  • {

    • "key_id": "string",
    • "key_hash": "string",
    • "user_id": "string",
    • "tenant_id": "string",
    • "created_at": {

      • "at": "2019-08-24T14:15:22Z",
      • "ip": "string",
      • "country": "string",
      • "user_agent": "string",
      • "user_agent_parsed": {

        • "browser": {

          • "family": "string",
          • "version": "string"

          },
        • "os": {

          • "family": "string",
          • "version": "string"

          },
        • "device": {

          • "family": "string",
          • "brand": "string",
          • "model": "string"

          },
        • "is_mobile": false,
        • "is_tablet": false,
        • "is_pc": false,
        • "is_bot": false

        }

      },
    • "name": "",
    • "scopes": [

      • "string"

      ],
    • "last_use_at": {

      • "at": "2019-08-24T14:15:22Z",
      • "ip": "string",
      • "country": "string",
      • "user_agent": "string",
      • "user_agent_parsed": {

        • "browser": {

          • "family": "string",
          • "version": "string"

          },
        • "os": {

          • "family": "string",
          • "version": "string"

          },
        • "device": {

          • "family": "string",
          • "brand": "string",
          • "model": "string"

          },
        • "is_mobile": false,
        • "is_tablet": false,
        • "is_pc": false,
        • "is_bot": false

        }

      },
    • "is_active": true,
    • "username": ""

    }

  ]

}

Delete Api Key

Authorizations:

APIKeyHeaderHTTPBearer

path Parameters

key_id required

string (Key Id)

Responses

http://docs.secretsvault.net/api/api-keys/key/{key_id}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Regenerate Api Key

Authorizations:

APIKeyHeaderHTTPBearer

path Parameters

key_id required

string (Key Id)

Responses

http://docs.secretsvault.net/api/api-keys/key/{key_id}/regenerate

Response samples

• 200
• 422

Content type

application/json

{

• "key_id": "string",
• "key_hash": "string",
• "user_id": "string",
• "tenant_id": "string",
• "created_at": {

  • "at": "2019-08-24T14:15:22Z",
  • "ip": "string",
  • "country": "string",
  • "user_agent": "string",
  • "user_agent_parsed": {

    • "browser": {

      • "family": "string",
      • "version": "string"

      },
    • "os": {

      • "family": "string",
      • "version": "string"

      },
    • "device": {

      • "family": "string",
      • "brand": "string",
      • "model": "string"

      },
    • "is_mobile": false,
    • "is_tablet": false,
    • "is_pc": false,
    • "is_bot": false

    }

  },
• "name": "",
• "scopes": [

  • "string"

  ],
• "last_use_at": {

  • "at": "2019-08-24T14:15:22Z",
  • "ip": "string",
  • "country": "string",
  • "user_agent": "string",
  • "user_agent_parsed": {

    • "browser": {

      • "family": "string",
      • "version": "string"

      },
    • "os": {

      • "family": "string",
      • "version": "string"

      },
    • "device": {

      • "family": "string",
      • "brand": "string",
      • "model": "string"

      },
    • "is_mobile": false,
    • "is_tablet": false,
    • "is_pc": false,
    • "is_bot": false

    }

  },
• "is_active": true,
• "api_key": "string"

}

Get Keys Scopes

Authorizations:

APIKeyHeaderHTTPBearer

Responses

http://docs.secretsvault.net/api/api-keys/scopes

Response samples

• 200

Content type

application/json

{

• "scopes": [

  • "string"

  ],
• "tenants": [

  • "string"

  ]

}

Tenants

Read Tenants

Authorizations:

APIKeyHeaderHTTPBearer

Responses

http://docs.secretsvault.net/api/tenants

Response samples

• 200

Content type

application/json

{

• "tenants": [

  • {

    • "tenant_id": "string",
    • "register_enable": false,
    • "is_2fa": false,
    • "use_pin": true,
    • "use_face_recognition": false,
    • "display_name": ""

    }

  ]

}

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
use_face_recognition	boolean (Use Face Recognition) Default: false
display_name	string (Display Name) Default: ""

Responses

http://docs.secretsvault.net/api/tenants

Request samples

• Payload

Content type

application/json

{

• "tenant_id": "string",
• "register_enable": false,
• "is_2fa": false,
• "use_pin": true,
• "use_face_recognition": false,
• "display_name": ""

}

Response samples

• 201
• 422

Content type

application/json

null

Read Tenant

Authorizations:

APIKeyHeaderHTTPBearer

path Parameters

tenant_id required

string (Tenant Id)

Responses

http://docs.secretsvault.net/api/tenants/{tenant_id}

Response samples

• 200
• 422

Content type

application/json

{

• "tenant_id": "string",
• "register_enable": false,
• "is_2fa": false,
• "use_pin": true,
• "use_face_recognition": false,
• "display_name": ""

}

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
use_face_recognition	boolean (Use Face Recognition) Default: false
display_name required	string (Display Name)

Responses

http://docs.secretsvault.net/api/tenants/{tenant_id}

Request samples

• Payload

Content type

application/json

{

• "register_enable": false,
• "use_pin": true,
• "use_face_recognition": false,
• "display_name": "string"

}

Response samples

• 200
• 422

Content type

application/json

null

Delete Tenant

Authorizations:

APIKeyHeaderHTTPBearer

path Parameters

tenant_id required

string (Tenant Id)

Responses

http://docs.secretsvault.net/api/tenants/{tenant_id}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

;