1. Docs
  2. API Reference
  3. OAuthClientResponseDto

OAuthClientResponseDto

Example

JSON
{
  "id": "string",
  "client_id": "string",
  "name": "string",
  "client_kind": "web",
  "organization_node_id": "string",
  "organization_name": "string",
  "allowed_audiences": [
    "string"
  ],
  "redirect_uris": [
    "string"
  ],
  "post_logout_redirect_uris": [
    "string"
  ],
  "grant_types": [
    "string"
  ],
  "scopes": [
    "string"
  ],
  "backchannel_logout_uri": "string",
  "invite_redirect_url": "string",
  "initiate_login_uri": "string",
  "is_active": false,
  "created_at": "2026-04-20T12:00:00.000Z",
  "issuer": "https://auth.yourapp.com"
}

Properties

17 properties 12 required

id string Required
client_id string Required
name string Required
client_kind enum Required

`web`: a person signs in through it. `machine`: it holds roles of its own and obtains tokens for itself with `client_credentials`.

Enumwebmachine
organization_node_id string Optional

The organization a machine client acts in: its tokens name it and its roles sit inside it. Null for a client that acts across the Environment, and for a web client.

nullable
organization_name string Optional

That organization's name; null when the client has none.

nullable
allowed_audiences array of string Required

The audiences a machine client may request a token for, beside the Environment's default. Empty for a web client.

redirect_uris array of string Required
post_logout_redirect_uris array of string Required

Where this client may send someone after RP-initiated logout, matched exactly.

grant_types array of string Required
scopes array of string Required
backchannel_logout_uri string Optional

Where Canopy delivers a logout token when a session ends. Null means the client is told nothing.

nullable
invite_redirect_url string Optional
nullable
initiate_login_uri string Optional

The route in the client's application that starts a sign-in (OpenID Connect `initiate_login_uri`), offered as **Sign in** on hosted pages that end with nothing to return to.

nullable
is_active boolean Required
created_at string Required
format: date-time
issuer string Required

The issuer this client's tokens name, which a relying party configures: `https://<custom auth domain>` while the Environment has an active one, else the Environment's own, `<platform origin>/environments/<environment_id>`. Its discovery document is at `<issuer>/.well-known/openid-configuration`.

Examplehttps://auth.yourapp.com
Was this page helpful?

Tell us how we can improve this guide.

Canopy