clients
Creates, updates, deletes, gets or lists a clients resource.
Overview​
| Name | clients |
| Type | Resource |
| Id | okta.authorizationservers.clients |
Fields​
The following fields are returned by SELECT queries:
- list_oauth2_clients_for_authorization_server
| Name | Datatype | Description |
|---|---|---|
client_id | string | Unique key for the client application. The client_id is immutable. (example: 0oabskvc6442nkvQO0h7) |
client_name | string | Human-readable string name of the client application (example: My App) |
_links | object | Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations. |
client_uri | string | (example: https://www.example.com) |
logo_uri | string | URL string that references a logo for the client consent dialog (not the sign-in dialog) (example: https://www.example.com/logo.png) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_oauth2_clients_for_authorization_server | select | authServerId, subdomain | Lists all client resources for which the specified authorization server has tokens. > Note: To list a specific user's client resources for which they have tokens or grants, use the List all clients endpoint in the User Resources API. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
authServerId | string | id of the Authorization Server |
subdomain | string | (default: my-org) |
SELECT examples​
- list_oauth2_clients_for_authorization_server
Lists all client resources for which the specified authorization server has tokens.
> Note: To list a specific user's client resources for which they have tokens or grants, use the List all clients endpoint in the User Resources API.
SELECT
client_id,
client_name,
_links,
client_uri,
logo_uri
FROM okta.authorizationservers.clients
WHERE authServerId = '{{ authServerId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;