Oauth

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/oauth \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_OAUTH",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "oidcToken": "<string>",
        "targetPublicKey": "<string>",
        "apiKeyName": "<string>",
        "expirationSeconds": "<string>",
        "invalidateExisting": "<boolean>"
    }
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_OAUTH",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "oauthIntent": {
            "oidcToken": "<string>",
            "targetPublicKey": "<string>",
            "apiKeyName": "<string>",
            "expirationSeconds": "<string>",
            "invalidateExisting": "<boolean>"
          }
        },
        "result": {
          "oauthResult": {
            "userId": "<string>",
            "apiKeyId": "<string>",
            "credentialBundle": "<string>"
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/oauth \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_OAUTH",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "oidcToken": "<string>",
        "targetPublicKey": "<string>",
        "apiKeyName": "<string>",
        "expirationSeconds": "<string>",
        "invalidateExisting": "<boolean>"
    }
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_OAUTH",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "oauthIntent": {
            "oidcToken": "<string>",
            "targetPublicKey": "<string>",
            "apiKeyName": "<string>",
            "expirationSeconds": "<string>",
            "invalidateExisting": "<boolean>"
          }
        },
        "result": {
          "oauthResult": {
            "userId": "<string>",
            "apiKeyId": "<string>",
            "credentialBundle": "<string>"
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

POST

public

submit

oauth

Authorizations

X-Stamp

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_OAUTH

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.oidcToken

string

required

Base64 encoded OIDC token

parameters.targetPublicKey

string

required

Client-side public key generated by the user, to which the oauth bundle (credentials) will be encrypted.

parameters.apiKeyName

string

Optional human-readable name for an API Key. If none provided, default to Oauth - <Timestamp>

parameters.expirationSeconds

string

Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used.

parameters.invalidateExisting

boolean

Invalidate all other previously generated Oauth API keys

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.oauthIntent

object

required

The oauthIntent object

Show oauthIntent details

activity.intent.oauthIntent.oidcToken

string

required

Base64 encoded OIDC token

activity.intent.oauthIntent.targetPublicKey

string

required

Client-side public key generated by the user, to which the oauth bundle (credentials) will be encrypted.

activity.intent.oauthIntent.apiKeyName

string

Optional human-readable name for an API Key. If none provided, default to Oauth - <Timestamp>

activity.intent.oauthIntent.expirationSeconds

string

Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used.

activity.intent.oauthIntent.invalidateExisting

boolean

Invalidate all other previously generated Oauth API keys

activity.result

object

required

The result of the activity

Show result details

activity.result.oauthResult

object

required

The oauthResult object

Show oauthResult details

activity.result.oauthResult.userId

string

required

Unique identifier for the authenticating User.

activity.result.oauthResult.apiKeyId

string

required

Unique identifier for the created API key.

activity.result.oauthResult.credentialBundle

string

required

HPKE encrypted credential bundle

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 --request POST \
  --url https://api.turnkey.com/public/v1/submit/oauth \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_OAUTH",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "oidcToken": "<string>",
        "targetPublicKey": "<string>",
        "apiKeyName": "<string>",
        "expirationSeconds": "<string>",
        "invalidateExisting": "<boolean>"
    }
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_OAUTH",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "oauthIntent": {
            "oidcToken": "<string>",
            "targetPublicKey": "<string>",
            "apiKeyName": "<string>",
            "expirationSeconds": "<string>",
            "invalidateExisting": "<boolean>"
          }
        },
        "result": {
          "oauthResult": {
            "userId": "<string>",
            "apiKeyId": "<string>",
            "credentialBundle": "<string>"
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

Activities

Queries

Authorizations

Body

Response