Update an OAuth 2.0 Credential

Update an OAuth 2.0 provider credential

POST

/

public

/

v1

/

submit

/

update_oauth2_credential

Authorizations

API Key

X-Stamp · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

WebAuthn (Passkey)

X-Stamp-WebAuthn · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_UPDATE_OAUTH2_CREDENTIAL

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

The parameters object containing the specific intent data for this activity.

Show details

parameters.oauth2CredentialId

string

required

The ID of the OAuth 2.0 credential to update

parameters.provider

enum<string>

required

Enum options: OAUTH2_PROVIDER_X, OAUTH2_PROVIDER_DISCORD

parameters.clientId

string

required

The Client ID issued by the OAuth 2.0 provider

parameters.encryptedClientSecret

string

required

The client secret issued by the OAuth 2.0 provider encrypted to the TLS Fetcher quorum key

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.id

string

required

Unique identifier for a given Activity object.

activity.organizationId

string

required

Unique identifier for a given Organization.

activity.status

string

required

The activity status

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.updateOauth2CredentialIntent

object

required

The updateOauth2CredentialIntent object

Show updateOauth2CredentialIntent details

activity.intent.updateOauth2CredentialIntent.oauth2CredentialId

string

required

The ID of the OAuth 2.0 credential to update

activity.intent.updateOauth2CredentialIntent.provider

enum

required

provider field

Enum options: OAUTH2_PROVIDER_X, OAUTH2_PROVIDER_DISCORD

activity.intent.updateOauth2CredentialIntent.clientId

string

required

The Client ID issued by the OAuth 2.0 provider

activity.intent.updateOauth2CredentialIntent.encryptedClientSecret

string

required

The client secret issued by the OAuth 2.0 provider encrypted to the TLS Fetcher quorum key

activity.result

object

required

The result of the activity

Show result details

activity.result.updateOauth2CredentialResult

object

required

The updateOauth2CredentialResult object

Show updateOauth2CredentialResult details

activity.result.updateOauth2CredentialResult.oauth2CredentialId

string

required

Unique identifier of the OAuth 2.0 credential that was updated

activity.votes

array

required

A list of objects representing a particular User’s approval or rejection of a Consensus request, including all relevant metadata.

activity.fingerprint

string

required

An artifact verifying a User’s action.

activity.canApprove

boolean

required

Whether the activity can be approved.

activity.canReject

boolean

required

Whether the activity can be rejected.

activity.createdAt

string

required

The creation timestamp.

activity.updatedAt

string

required

The last update timestamp.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/update_oauth2_credential \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_UPDATE_OAUTH2_CREDENTIAL",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "oauth2CredentialId": "<string>",
        "provider": "<OAUTH2_PROVIDER_X>",
        "clientId": "<string>",
        "encryptedClientSecret": "<string>"
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UPDATE_OAUTH2_CREDENTIAL",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "updateOauth2CredentialIntent": {
            "oauth2CredentialId": "<string>",
            "provider": "<OAUTH2_PROVIDER_X>",
            "clientId": "<string>",
            "encryptedClientSecret": "<string>"
          }
        },
        "result": {
          "updateOauth2CredentialResult": {
            "oauth2CredentialId": "<string>"
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}