External OAuth Client

Create provisions a durable static OAuth client for a pre-registered consumer, eligible for authorization_code + refresh_token only. A secret-based client's secret is returned once, on this response.

post/api/v1/iam/external_oauth_clients

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/iam/external_oauth_clients
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Request body

authMethod'EXTERNAL_O_AUTH_CLIENT_AUTH_METHOD_UNSPECIFIED' | 'EXTERNAL_O_AUTH_CLIENT_AUTH_METHOD_CLIENT_SECRET_BASIC' | 'EXTERNAL_O_AUTH_CLIENT_AUTH_METHOD_CLIENT_SECRET_POST' | 'EXTERNAL_O_AUTH_CLIENT_AUTH_METHOD_PRIVATE_KEY_JWT'

The authMethod field.

clientNamestring

Operator-facing name shown on the consent screen and in the admin list.

publicJwksstring

RFC 7517 JWK Set. Required when auth_method is PRIVATE_KEY_JWT and rejected otherwise.

redirectUrisstring[] nullable

Exact redirect URIs the client may be sent to. Microsoft's fixed literal, for example, is registered here.

Response

Successful response

clientSecretstring

Revealed once. Empty for PRIVATE_KEY_JWT.

Changes