Authentication

Save an org's OAuth client for a provider

Changed on

Requires the Manage OAuth apps permission. Lets an org bring its own OAuth app (client id + secret) for a native provider such as google-workspace, instead of relying on an OpenWork-owned client.

post/v1/oauth-providers/{providerId}/client

Request

  • Base URL: https://api.openworklabs.com
  • URL: https://api.openworklabs.com/v1/oauth-providers/{providerId}/client
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

providerIdstring required

Request body

clientIdstring
clientSecretstring
featuresstring[]
tenantIdstring

Response

OAuth client saved.

oktrue required
providerIdstring required
clientIdstring required
featuresstring[] required
tenantIdstring nullable required

Changes

  • df3754993784Revision changes
    • info

      added the optional property to the response with the status

  • bb8ff73e4ad3Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      the endpoint scheme security denApiKey was added to the API