OAuth Clients

Retrieve OAUTH Client

get/v1/oauth-clients/{client_id}

Request

  • Base URL: https://api.withone.ai
  • URL: https://api.withone.ai/v1/oauth-clients/{client_id}
  • Auth: Session (a scheme the document does not define)

Path parameters

client_idstring required

Public OAuth client ID

Response

OAuth client details

accessTokenTtlinteger nullable
clientIdstring required
clientTypestring required
consentReasonstring nullable

The sentence this app's consent screen shows. Read back as well as written, so the editor that set it can show the owner what it says.

consentSurface'hosted' | 'connect' required

Where an OAuth client's users are sent to grant consent.

The surface used to be read off the client id, so a client could only get a different one by being renamed, and every existing client would have moved the moment the rule changed. Naming it on the row makes it a property of the client that its owner can see and set, and leaves the ones already running exactly where they are.

createdAtstring date-time required
descriptionstring nullable
grantTypesstring[] required
homepageUrlstring nullable
idstring required

Prefixed ID with 'oac' prefix (e.g., 'oac_1C'), also accepts raw integer

isActiveboolean required
logoUrlstring nullable
namestring required
organizationIdstring uuid nullable
projectIdstring uuid nullable
redirectUrisstring[] required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.