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

Telnyx Oauth - Go

Installation

go get github.com/team-telnyx/telnyx-go

Setup

import (
  "context"
  "fmt"
  "os"

  "github.com/team-telnyx/telnyx-go"
  "github.com/team-telnyx/telnyx-go/option"
)

client := telnyx.NewClient(
  option.WithAPIKey(os.Getenv("TELNYX_API_KEY")),
)

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

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

import "errors"

result, err := client.Messages.Send(ctx, params)
if err != nil {
  var apiErr *telnyx.Error
  if errors.As(err, &apiErr) {
    switch apiErr.StatusCode {
    case 422:
      fmt.Println("Validation error — check required fields and formats")
    case 429:
      // Rate limited — wait and retry with exponential backoff
      fmt.Println("Rate limited, retrying...")
    default:
      fmt.Printf("API error %d: %s\n", apiErr.StatusCode, apiErr.Error())
    }
  } else {
    fmt.Println("Network error — check connectivity and retry")
  }
}

Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).

Important Notes

• Pagination: Use ListAutoPaging() for automatic iteration: iter := client.Resource.ListAutoPaging(ctx, params); for iter.Next() { item := iter.Current() }.

Authorization server metadata

OAuth 2.0 Authorization Server Metadata (RFC 8414)

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

	response, err := client.WellKnown.GetAuthorizationServerMetadata(context.Background())
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.AuthorizationEndpoint)

Returns: authorizationendpoint (uri), codechallengemethodssupported (array[string]), granttypessupported (array[string]), introspectionendpoint (uri), issuer (uri), jwksuri (uri), registrationendpoint (uri), responsetypessupported (array[string]), scopessupported (array[string]), tokenendpoint (uri), tokenendpointauthmethods_supported (array[string])

Protected resource metadata

OAuth 2.0 Protected Resource Metadata for resource discovery

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

	response, err := client.WellKnown.GetProtectedResourceMetadata(context.Background())
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.AuthorizationServers)

Returns: authorization_servers (array[string]), resource (uri)

OAuth authorization endpoint

OAuth 2.0 authorization endpoint for the authorization code flow

GET /oauth/authorize

	err := client.OAuth.GetAuthorize(context.Background(), telnyx.OAuthGetAuthorizeParams{
		ClientID: "550e8400-e29b-41d4-a716-446655440000",
		RedirectUri:  "https://example.com",
		ResponseType: telnyx.OAuthGetAuthorizeParamsResponseTypeCode,
	})
	if err != nil {
		log.Fatal(err)
	}

Get OAuth consent token

Retrieve details about an OAuth consent token

GET /oauth/consent/{consent_token}

	oauth, err := client.OAuth.Get(context.Background(), "consent_token")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", oauth.Data)

Returns: clientid (string), logouri (uri), name (string), policyuri (uri), redirecturi (uri), requestedscopes (array[object]), tosuri (uri), verified (boolean)

Create OAuth grant

Create an OAuth authorization grant

POST /oauth/grants — Required: allowed, consent_token

	response, err := client.OAuth.Grants(context.Background(), telnyx.OAuthGrantsParams{
		Allowed:      true,
		ConsentToken: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.example",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.RedirectUri)

Returns: redirect_uri (uri)

Token introspection

Introspect an OAuth access token to check its validity and metadata

POST /oauth/introspect — Required: token

	response, err := client.OAuth.Introspect(context.Background(), telnyx.OAuthIntrospectParams{
		Token: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.example",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.ClientID)

Returns: active (boolean), aud (string), client_id (string), exp (integer), iat (integer), iss (string), scope (string)

JSON Web Key Set

Retrieve the JSON Web Key Set for token verification

GET /oauth/jwks

	response, err := client.OAuth.GetJwks(context.Background())
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Keys)

Returns: keys (array[object])

Dynamic client registration

Register a new OAuth client dynamically (RFC 7591)

POST /oauth/register

Optional: clientname (string), granttypes (array[string]), logouri (uri), policyuri (uri), redirecturis (array[string]), responsetypes (array[string]), scope (string), tokenendpointauthmethod (enum: none, clientsecretbasic, clientsecretpost), tosuri (uri)

	response, err := client.OAuth.Register(context.Background(), telnyx.OAuthRegisterParams{})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.ClientID)

Returns: clientid (string), clientidissuedat (integer), clientname (string), clientsecret (string), granttypes (array[string]), logouri (uri), policyuri (uri), redirecturis (array[string]), responsetypes (array[string]), scope (string), tokenendpointauthmethod (string), tos_uri (uri)

OAuth token endpoint

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

POST /oauth/token — Required: grant_type

Optional: clientid (string), clientsecret (string), code (string), codeverifier (string), redirecturi (uri), refresh_token (string), scope (string)

	response, err := client.OAuth.Token(context.Background(), telnyx.OAuthTokenParams{
		GrantType: telnyx.OAuthTokenParamsGrantTypeClientCredentials,
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.AccessToken)

Returns: accesstoken (string), expiresin (integer), refreshtoken (string), scope (string), tokentype (enum: Bearer)

List OAuth clients

Retrieve a paginated list of OAuth clients for the authenticated user

GET /oauth_clients

	page, err := client.OAuthClients.List(context.Background(), telnyx.OAuthClientListParams{})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", page)

Returns: allowedgranttypes (array[string]), allowedscopes (array[string]), clientid (string), clientsecret (string | null), clienttype (enum: public, confidential), createdat (date-time), logouri (uri), name (string), orgid (string), policyuri (uri), recordtype (enum: oauthclient), redirecturis (array[string]), requirepkce (boolean), tosuri (uri), updatedat (date-time), user_id (string)

Create OAuth client

Create a new OAuth client

POST /oauthclients — Required: name, allowedscopes, clienttype, allowedgrant_types

Optional: logouri (uri), policyuri (uri), redirecturis (array[string]), requirepkce (boolean), tos_uri (uri)

	oauthClient, err := client.OAuthClients.New(context.Background(), telnyx.OAuthClientNewParams{
		AllowedGrantTypes: []string{"client_credentials"},
		AllowedScopes:     []string{"admin"},
		ClientType:        telnyx.OAuthClientNewParamsClientTypePublic,
		Name:              "My OAuth client",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", oauthClient.Data)

Returns: allowedgranttypes (array[string]), allowedscopes (array[string]), clientid (string), clientsecret (string | null), clienttype (enum: public, confidential), createdat (date-time), logouri (uri), name (string), orgid (string), policyuri (uri), recordtype (enum: oauthclient), redirecturis (array[string]), requirepkce (boolean), tosuri (uri), updatedat (date-time), user_id (string)

Get OAuth client

Retrieve a single OAuth client by ID

GET /oauth_clients/{id}

	oauthClient, err := client.OAuthClients.Get(context.Background(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", oauthClient.Data)

Returns: allowedgranttypes (array[string]), allowedscopes (array[string]), clientid (string), clientsecret (string | null), clienttype (enum: public, confidential), createdat (date-time), logouri (uri), name (string), orgid (string), policyuri (uri), recordtype (enum: oauthclient), redirecturis (array[string]), requirepkce (boolean), tosuri (uri), updatedat (date-time), user_id (string)

Update OAuth client

Update an existing OAuth client

PUT /oauth_clients/{id}

Optional: allowedgranttypes (array[string]), allowedscopes (array[string]), logouri (uri), name (string), policyuri (uri), redirecturis (array[string]), requirepkce (boolean), tosuri (uri)

	oauthClient, err := client.OAuthClients.Update(
		context.Background(),
		"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
		telnyx.OAuthClientUpdateParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", oauthClient.Data)

Returns: allowedgranttypes (array[string]), allowedscopes (array[string]), clientid (string), clientsecret (string | null), clienttype (enum: public, confidential), createdat (date-time), logouri (uri), name (string), orgid (string), policyuri (uri), recordtype (enum: oauthclient), redirecturis (array[string]), requirepkce (boolean), tosuri (uri), updatedat (date-time), user_id (string)

Delete OAuth client

Delete an OAuth client

DELETE /oauth_clients/{id}

	err := client.OAuthClients.Delete(context.Background(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
	if err != nil {
		log.Fatal(err)
	}

List OAuth grants

Retrieve a paginated list of OAuth grants for the authenticated user

GET /oauth_grants

	page, err := client.OAuthGrants.List(context.Background(), telnyx.OAuthGrantListParams{})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", page)

Returns: clientid (string), createdat (date-time), id (uuid), lastusedat (date-time), recordtype (enum: oauthgrant), scopes (array[string])

Get OAuth grant

Retrieve a single OAuth grant by ID

GET /oauth_grants/{id}

	oauthGrant, err := client.OAuthGrants.Get(context.Background(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", oauthGrant.Data)

Returns: clientid (string), createdat (date-time), id (uuid), lastusedat (date-time), recordtype (enum: oauthgrant), scopes (array[string])

Revoke OAuth grant

Revoke an OAuth grant

DELETE /oauth_grants/{id}

	oauthGrant, err := client.OAuthGrants.Delete(context.Background(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", oauthGrant.Data)

Returns: clientid (string), createdat (date-time), id (uuid), lastusedat (date-time), recordtype (enum: oauthgrant), scopes (array[string])