Create Oauth providers

Partial — accepted by the Coordinator but the executor currently returns an empty provider_ids list; provider linking is not yet productized in Phase 1. Track progress on the Roadmap.

type

enum<string>

required

Enum options: ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS_V2

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

array

required

A list of Oauth providers.

Show item details

parameters.oauthProviders.oidcClaims

object

oidcClaims field

Show details

generateAppProofs

boolean

Enable to have your activity generate and return App Proofs, enabling verifiability.

A successful response returns the following fields:

activity

object

required

The activity object containing type, intent, and result

Show activity details

curl --request POST \
  --url https://api.0xkey.io/public/v1/submit/create_oauth_providers \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS_V2",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "userId": "<string>",
        "oauthProviders": [
            {
                "providerName": "<string>",
                "oidcToken": "<string>",
                "oidcClaims": {
                    "iss": "<string>",
                    "sub": "<string>",
                    "aud": "<string>"
                }
            }
        ]
    }
}'

import { ZeroXKey } from "@0xkey-io/sdk-server";

const zeroXKey = new ZeroXKey({
  apiBaseUrl: "https://api.0xkey.io",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await zeroXKey.apiClient().createOauthProviders({
  userId: "<string> (The ID of the User to add an Oauth provider to)",
  oauthProviders: [{ // A list of Oauth providers.,
    providerName: "<string> (Human-readable name to identify a Provider.)",
    oidcToken: "<string> (Base64 encoded OIDC token)",
    oidcClaims: { // oidcClaims field,
      iss: "<string> (The issuer identifier from the OIDC token (iss claim))",
      sub: "<string> (The subject identifier from the OIDC token (sub claim))",
      aud: "<string> (The audience from the OIDC token (aud claim))",
    },
  }]
});

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS_V2",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "createOauthProvidersIntentV2": {
            "userId": "<string>",
            "oauthProviders": [
              {
                "providerName": "<string>",
                "oidcToken": "<string>",
                "oidcClaims": {
                  "iss": "<string>",
                  "sub": "<string>",
                  "aud": "<string>"
                }
              }
            ]
          }
        },
        "result": {
          "createOauthProvidersResultV2": {
            "providerIds": [
              "<string>"
            ]
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

curl --request POST \
  --url https://api.0xkey.io/public/v1/submit/create_oauth_providers \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS_V2",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "userId": "<string>",
        "oauthProviders": [
            {
                "providerName": "<string>",
                "oidcToken": "<string>",
                "oidcClaims": {
                    "iss": "<string>",
                    "sub": "<string>",
                    "aud": "<string>"
                }
            }
        ]
    }
}'

import { ZeroXKey } from "@0xkey-io/sdk-server";

const zeroXKey = new ZeroXKey({
  apiBaseUrl: "https://api.0xkey.io",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await zeroXKey.apiClient().createOauthProviders({
  userId: "<string> (The ID of the User to add an Oauth provider to)",
  oauthProviders: [{ // A list of Oauth providers.,
    providerName: "<string> (Human-readable name to identify a Provider.)",
    oidcToken: "<string> (Base64 encoded OIDC token)",
    oidcClaims: { // oidcClaims field,
      iss: "<string> (The issuer identifier from the OIDC token (iss claim))",
      sub: "<string> (The subject identifier from the OIDC token (sub claim))",
      aud: "<string> (The audience from the OIDC token (aud claim))",
    },
  }]
});

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS_V2",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "createOauthProvidersIntentV2": {
            "userId": "<string>",
            "oauthProviders": [
              {
                "providerName": "<string>",
                "oidcToken": "<string>",
                "oidcClaims": {
                  "iss": "<string>",
                  "sub": "<string>",
                  "aud": "<string>"
                }
              }
            ]
          }
        },
        "result": {
          "createOauthProvidersResultV2": {
            "providerIds": [
              "<string>"
            ]
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}