Update OAuth client

Update an existing OAuth client

PUT /oauth/clients/{id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const oauthClient = await client.oauthClients.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(oauthClient.data);

200

{
  "data": {
    "record_type": "oauth_client",
    "client_id": "<string>",
    "name": "<string>",
    "org_id": "<string>",
    "user_id": "<string>",
    "client_type": "public",
    "require_pkce": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "allowed_scopes": [
      "<string>"
    ],
    "allowed_grant_types": [
      "client_credentials"
    ],
    "redirect_uris": [
      "<string>"
    ],
    "logo_uri": "<string>",
    "tos_uri": "<string>",
    "policy_uri": "<string>",
    "client_secret": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string<uuid> · required

OAuth client ID

Body

application/json

name · string

The name of the OAuth client

allowed_scopes · string[]

List of allowed OAuth scopes

Example:

["admin"]

require_pkce · boolean

Whether PKCE (Proof Key for Code Exchange) is required for this client

allowed_grant_types · enum<string>[]

List of allowed OAuth grant types

Available options: client_credentials, authorization_code, refresh_token

redirect_uris · string<uri>[]

List of redirect URIs

logo_uri · string<uri>

URL of the client logo

policy_uri · string<uri>

URL of the client's privacy policy

tos_uri · string<uri>

URL of the client's terms of service

Response

200

application/json

OAuth client updated successfully

data · object

Show child attributes