team-telnyx/telnyx-oauth-python

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Oauth - Python

Installation

pip install telnyx

Setup

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)

All examples below assume client is already initialized as shown above.

Authorization server metadata

OAuth 2.0 Authorization Server Metadata (RFC 8414)

GET /.well-known/oauth-authorization-server

response = client.well_known.retrieve_authorization_server_metadata()
print(response.authorization_endpoint)

Protected resource metadata

OAuth 2.0 Protected Resource Metadata for resource discovery

GET /.well-known/oauth-protected-resource

response = client.well_known.retrieve_protected_resource_metadata()
print(response.authorization_servers)

OAuth authorization endpoint

OAuth 2.0 authorization endpoint for the authorization code flow

GET /oauth/authorize

client.oauth.retrieve_authorize(
    client_id="client_id",
    redirect_uri="https://example.com",
    response_type="code",
)

List OAuth clients

Retrieve a paginated list of OAuth clients for the authenticated user

GET /oauth/clients

page = client.oauth_clients.list()
page = page.data[0]
print(page.client_id)

Create OAuth client

Create a new OAuth client

POST /oauth/clients — Required: name, allowed_scopes, client_type, allowed_grant_types

oauth_client = client.oauth_clients.create(
    allowed_grant_types=["client_credentials"],
    allowed_scopes=["admin"],
    client_type="public",
    name="My OAuth client",
)
print(oauth_client.data)

Get OAuth client

Retrieve a single OAuth client by ID

GET /oauth/clients/{id}

oauth_client = client.oauth_clients.retrieve(
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(oauth_client.data)

Update OAuth client

Update an existing OAuth client

PUT /oauth/clients/{id}

oauth_client = client.oauth_clients.update(
    id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(oauth_client.data)

Delete OAuth client

Delete an OAuth client

DELETE /oauth/clients/{id}

client.oauth_clients.delete(
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)

Get OAuth consent token

Retrieve details about an OAuth consent token

GET /oauth/consent/{consent_token}

oauth = client.oauth.retrieve(
    "consent_token",
)
print(oauth.data)

List OAuth grants

Retrieve a paginated list of OAuth grants for the authenticated user

GET /oauth/grants

page = client.oauth_grants.list()
page = page.data[0]
print(page.id)

Get OAuth grant

Retrieve a single OAuth grant by ID

GET /oauth/grants/{id}

oauth_grant = client.oauth_grants.retrieve(
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(oauth_grant.data)

Revoke OAuth grant

Revoke an OAuth grant

DELETE /oauth/grants/{id}

oauth_grant = client.oauth_grants.delete(
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(oauth_grant.data)

Token introspection

Introspect an OAuth access token to check its validity and metadata

POST /oauth/introspect — Required: token

response = client.oauth.introspect(
    token="token",
)
print(response.client_id)

JSON Web Key Set

Retrieve the JSON Web Key Set for token verification

GET /oauth/jwks

response = client.oauth.retrieve_jwks()
print(response.keys)

Dynamic client registration

Register a new OAuth client dynamically (RFC 7591)

POST /oauth/register

response = client.oauth.register()
print(response.client_id)

OAuth token endpoint

Exchange authorization code, client credentials, or refresh token for access token

POST /oauth/token — Required: grant_type

response = client.oauth.token(
    grant_type="client_credentials",
)
print(response.access_token)