Update OIDC provider

Part of OIDC Federation. The issuer field is immutable — if it needs to change, delete and re-create the provider instead. Setting enabled: false is the fastest way to reject logins from a provider without losing its configuration or breaking existing per-user identity bindings.

type

enum<string>

required

Enum options: ACTIVITY_TYPE_UPDATE_OIDC_PROVIDER

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

array

New audience allowlist — replaces the existing list wholesale if provided. Omit to leave unchanged. If provided, must be non-empty (fail-closed: no wildcard trust).

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/update_oidc_provider \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations — root-quorum signature required)" \
  --data '{
    "type": "ACTIVITY_TYPE_UPDATE_OIDC_PROVIDER",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your parent Organization ID)",
    "parameters": {
        "providerId": "<string>",
        "audiences": ["<string>", "<string>"],
        "enabled": false
    }
}'

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().updateOidcProvider({
  providerId: "<string>",
  audiences: ["<string>", "<string>"],
  enabled: false,
});

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UPDATE_OIDC_PROVIDER",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "updateOidcProviderResult": {
        "providerId": "<string>"
      }
    },
    "votes": "<array>",
    "fingerprint": "<string>",
    "canApprove": "<boolean>",
    "canReject": "<boolean>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

curl --request POST \
  --url https://api.0xkey.io/public/v1/submit/update_oidc_provider \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations — root-quorum signature required)" \
  --data '{
    "type": "ACTIVITY_TYPE_UPDATE_OIDC_PROVIDER",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your parent Organization ID)",
    "parameters": {
        "providerId": "<string>",
        "audiences": ["<string>", "<string>"],
        "enabled": false
    }
}'

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().updateOidcProvider({
  providerId: "<string>",
  audiences: ["<string>", "<string>"],
  enabled: false,
});

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UPDATE_OIDC_PROVIDER",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "updateOidcProviderResult": {
        "providerId": "<string>"
      }
    },
    "votes": "<array>",
    "fingerprint": "<string>",
    "canApprove": "<boolean>",
    "canReject": "<boolean>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Webhooks

Public API

Update OIDC provider