Okta Scopes

Scope Request Summary

Clients will request the appropriate Okta scopes when fetching an access token.

When requesting a token from:

https://{yourOktaDomain}/oauth2/{authServerId}/v1/token

the required scopes are passed in the scope parameter as part of the token request, for example:

grant_type=client_credentials&scope={yourCustomScope}

Update this scope parameter to include the scopes required for the API operations your client uses.

• Request the read-only scope if the client only needs to perform queries/read operations.
• Request the full scope only if the client needs to run mutations/write operations.
• A full scope also satisfies the corresponding read access where supported, so clients that need both queries and mutations should request the full scope rather than both.

For example, a client that only reads wallet data should request:

scope=wallets.readonly

A client that needs to create or update wallets should request:

scope=wallets

The same pattern applies to the other scope groups, such as bank_transactions, transfers, and institutions.

Scope Changes

Operation Category	Query/Mutation	Scope Required
Wallet Queries (2)
wallets	Query	(wallets.readonly OR wallets)
wallet	Query	(wallets.readonly OR wallets)
Wallet Mutations (5)
walletCreate	Mutation	wallets
walletUpdate	Mutation	wallets
walletSigningKeyCreate	Mutation	wallets
walletSigningKeyDelete	Mutation	wallets
walletSigningKeySubmit	Mutation	wallets
Deposit Queries (2)
deposits	Query	bank_transactions.readonly
deposit	Query	bank_transactions.readonly
Deposit Mutations (3)
depositCreate	Mutation	bank_transactions
depositCancel	Mutation	bank_transactions
depositApprove	Mutation	bank_transactions
Withdrawal Queries (2)
withdrawals	Query	bank_transactions.readonly
withdrawal	Query	bank_transactions.readonly
Withdrawal Mutations (3)
withdrawalCreate	Mutation	bank_transactions
withdrawalCancel	Mutation	bank_transactions
withdrawalApprove	Mutation	bank_transactions
Transfer Queries (2)
transfers	Query	(transfers.readonly OR transfers)
transfer	Query	(transfers.readonly OR transfers)
Transfer Mutations (3)
transferCreate	Mutation	transfers
transferApprove	Mutation	transfers
transferSubmit	Mutation	transfers
Institution Entity Queries (2)
institutionEntities	Query	institutions.readonly
institutionEntity	Query	institutions.readonly