import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const oauthClients = await client.oauthClients.list();
console.log(oauthClients.data);{
"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>"
}
],
"meta": {
"page_number": 123,
"page_size": 123,
"total_results": 123,
"total_pages": 123
}
}Retrieve a paginated list of OAuth clients for the authenticated user
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const oauthClients = await client.oauthClients.list();
console.log(oauthClients.data);{
"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>"
}
],
"meta": {
"page_number": 123,
"page_size": 123,
"total_results": 123,
"total_pages": 123
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Number of results per page
1 <= x <= 100Page number
x >= 1Filter by client type
confidential, public Filter by verification status
Filter by allowed grant type
client_credentials, authorization_code, refresh_token Filter by exact client name
Filter by client name containing text
Filter by client ID
List of OAuth clients
Show child attributes
Record type identifier
oauth_client OAuth client identifier
Human-readable name for the OAuth client
Organization ID that owns this OAuth client
User ID that created this OAuth client
OAuth client type
public, confidential Whether PKCE (Proof Key for Code Exchange) is required for this client
Timestamp when the client was created
Timestamp when the client was last updated
List of allowed OAuth scopes
List of allowed OAuth grant types
client_credentials, authorization_code, refresh_token List of allowed redirect URIs
URL of the client logo
URL of the client's terms of service
URL of the client's privacy policy
Client secret (only included when available, for confidential clients)
Was this page helpful?