Skip to content
Subako Docs
English
English日本語Not translated
Esc
↑↓navigate↵open⌘Jpreview

List OAuth clients

GET/v1/oauth-clients
Authorization
AuthorizationBearer token · headerrequired
Query parameters
limitinteger<int64>
min 1 · max 200
afterstring<uuid>
Rows past this id in `order`'s direction: a page's `next_cursor`.
beforestring<uuid>
Rows just before this id, still in `order`'s direction: a page's `prev_cursor`.
orderOrderParam
Newest first when omitted.
Allowed:ascdesc
Header parameters
Kikuvi-Workspacestring<uuid>
Workspace to list from. Required for a user caller; implied by the key for an API key caller.
Responses
200One page, newest first unless order=asc; never a secret.
itemsOAuthClientBody[]required
Show properties
Array of OAuthClientBody
authorization_endpointstringrequired
authorization_paramsAuthorizationParamBody[]required
Show properties
Array of AuthorizationParamBody
namestringrequired
Letters, digits, and `-._~`; none Subako sets itself (`response_type`, `client_id`, `redirect_uri`, `state`, `code_challenge`, `code_challenge_method`, `scope`, `resource`).
min length 1 · max length 64
valuestringrequired
max length 512
client_idstringrequired
created_atstring<date-time>required
display_namestringrequired
idstring<uuid>required
scopesOAuthScopeBody[]required
token_endpointstringrequired
token_endpoint_auth_methodTokenEndpointAuthMethodBodyrequired
How the client authenticates at the token endpoint, without its secret.
Allowed:noneclient_secret_postclient_secret_basic
updated_atstring<date-time>required
workspace_idstring<uuid>required
next_cursorstring<uuid> | nullrequired
Pass back as `after` for the next page; `null` on the last page.
prev_cursorstring<uuid> | nullrequired
Pass back as `before` for the previous page; `null` on the first page.
400Bad limit, cursor, or order, a malformed workspace header, or a user caller with no workspace header.
errorErrorDetailrequired
What went wrong: a `code` to branch on and a `message` to show. The message is written for a person and may change; the code will not.
Show properties
codeErrorCoderequired
The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.
Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal
messagestringrequired
401Missing, malformed, or invalid bearer token.
errorErrorDetailrequired
What went wrong: a `code` to branch on and a `message` to show. The message is written for a person and may change; the code will not.
Show properties
codeErrorCoderequired
The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.
Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal
messagestringrequired
403Caller lacks vault.read, or an API key's Kikuvi-Workspace header names another workspace.
errorErrorDetailrequired
What went wrong: a `code` to branch on and a `message` to show. The message is written for a person and may change; the code will not.
Show properties
codeErrorCoderequired
The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.
Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal
messagestringrequired
404No such workspace, or the caller cannot see it.
errorErrorDetailrequired
What went wrong: a `code` to branch on and a `message` to show. The message is written for a person and may change; the code will not.
Show properties
codeErrorCoderequired
The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.
Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET "https://api.us.cloud.subako.ai/v1/oauth-clients" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "items": [
    {
      "authorization_endpoint": "string",
      "authorization_params": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "client_id": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "display_name": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "scopes": [
        "string"
      ],
      "token_endpoint": "string",
      "token_endpoint_auth_method": "none",
      "updated_at": "2019-08-24T14:15:22Z",
      "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
    }
  ],
  "next_cursor": "a7ec8888-a9c3-4732-a281-9a08510f220b",
  "prev_cursor": "2ffdd032-1f96-48c2-8179-571201598694"
}