Create Oauth Providers

Creates Oauth providers for a specified user - BETA

POST

/

public

/

v1

/

submit

/

create_oauth_providers

Authorizations

API Key

X-Stamp

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

parameters field

Show details

parameters.userId

string

required

The ID of the User to add an Oauth provider to

parameters.oauthProviders · array · required

A list of Oauth providers.

Show item details

parameters.oauthProviders.providerName

string

required

Human-readable name to identify a Provider.

parameters.oauthProviders.oidcToken

string

required

Base64 encoded OIDC token

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.createOauthProvidersIntent

object

required

The createOauthProvidersIntent object

Show createOauthProvidersIntent details

activity.intent.createOauthProvidersIntent.userId

string

required

The ID of the User to add an Oauth provider to

activity.intent.createOauthProvidersIntent.oauthProviders

array

required

A list of Oauth providers.

Show oauthProviders details

activity.intent.createOauthProvidersIntent.oauthProviders.providerName

string

required

Human-readable name to identify a Provider.

activity.intent.createOauthProvidersIntent.oauthProviders.oidcToken

string

required

Base64 encoded OIDC token

activity.result

object

required

The result of the activity

Show result details

activity.result.createOauthProvidersResult

object

required

The createOauthProvidersResult object

Show createOauthProvidersResult details

activity.result.createOauthProvidersResult.providerIds

array

required

A list of unique identifiers for Oauth Providers

Show providerIds details

activity.result.createOauthProvidersResult.providerIds.item

string

required

item field

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/create_oauth_providers \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "userId": "<string>",
        "oauthProviders": [
            {
                "providerName": "<string>",
                "oidcToken": "<string>"
            }
        ]
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "createOauthProvidersIntent": {
            "userId": "<string>",
            "oauthProviders": [
              {
                "providerName": "<string>",
                "oidcToken": "<string>"
              }
            ]
          }
        },
        "result": {
          "createOauthProvidersResult": {
            "providerIds": [
              "<string_element>"
            ]
          }
        }
      }
    }
  }
}