Admin Create OAuth Client

post/api/v2/admin/oauth/client

Admin route to create a new OAuth client - The generated clientId and redirect URIs are whitelisted and can be used for OAuth 2.0 authorization flows.

Request Body

redirectUri array[string] required
List of whitelisted redirect URIs
scopeOne ofrequired
List of allowed OAuth scopes for the OAuth client
Allowed values: openid openid_enterprises profile user_manage wallet_create private_verify_email all wallet_view_enterprise wallet_edit_enterprise wallet_spend_enterprise wallet_approve_enterprise wallet_manage_enterprise wallet_view wallet_edit wallet_freeze wallet_spend wallet_approve wallet_manage wallet_stake wallet_trade wallet_view_all wallet_edit_all wallet_freeze_all wallet_spend_all wallet_approve_all wallet_manage_all wallet_stake_all enterprise_view_all enterprise_manage_all auditlogs_view_all trade_view trade_fix scim
clientIdPrefix string
Optional prefix for the clientId
clientType string
The type of OAuth client
Allowed values: dApp scim
redirectDomain array[string]
List of whitelisted redirect domains
enterprise string
The enterprise that the OAuth client ties to
clientOrganizations array[string]
List of organizations associated with the OAuth client
isActive boolean
Whether the OAuth client is active on creation. Defaults to true when omitted.

200 Response

clientId string required
The uniqueclient ID of the OAuth client
redirectUri array[string] required
Whitelisted redirect URIs
scopeOne ofrequired
Allowed scopes for the OAuth client
Allowed values: openid openid_enterprises profile user_manage wallet_create private_verify_email all wallet_view_enterprise wallet_edit_enterprise wallet_spend_enterprise wallet_approve_enterprise wallet_manage_enterprise wallet_view wallet_edit wallet_freeze wallet_spend wallet_approve wallet_manage wallet_stake wallet_trade wallet_view_all wallet_edit_all wallet_freeze_all wallet_spend_all wallet_approve_all wallet_manage_all wallet_stake_all enterprise_view_all enterprise_manage_all auditlogs_view_all trade_view trade_fix scim
clientType string
The type of the OAuth client
Allowed values: dApp scim
clientSecret string
The client secret of the OAuth client
redirectDomain array[string]
Whitelisted redirect domains
enterprise string
The enterprise that the OAuth client ties to
organizationConfig object
Organization configuration for the OAuth client
clientOrganizations array[string] required
List of organizations associated with the OAuth client
isActive boolean
Whether the OAuth client is active. Defaults to true. Setting false soft-disables the client.

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

401 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

404 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id