Get the workspace's workload identity
The issuer and subject a cloud account, an Anthropic organization, or an OpenAI organization trusts so that a model provider can authenticate as this workspace, with no long-lived credential handed over. A role whose trust policy, a federation rule whose match, or a mapping whose sub pins this subject admits this workspace and no other.
GET
/v1/workload-identityAuthorization
AuthorizationBearer token · headerrequiredHeader parameters
Kikuvi-Workspacestring<uuid>Workspace to read. Required for a user caller; implied by the key for an API key caller.
Responses
200The workspace's issuer and subject.
anthropicAnthropicWorkloadIdentityBodyrequiredWhat an Anthropic organization needs beyond the issuer and subject.
Show propertiesHide properties
audiencestringrequiredThe `aud` of tokens exchanged at the Claude API, and the `audience` a
federation rule's match checks.
awsAwsWorkloadIdentityBodyrequiredWhat an AWS account needs beyond the issuer and subject.
Show propertiesHide properties
audiencestringrequiredThe audience (client id) to register the issuer under in IAM, and the
`aud` a role's trust policy checks.
issuerstringrequiredThe OpenID Connect issuer every workspace token names. Register it as
an identity provider in your cloud account or your OpenAI
organization, or as a federation issuer in your Anthropic
organization; its discovery document is at
`{issuer}/.well-known/openid-configuration`.
openaiOpenaiWorkloadIdentityBodyrequiredWhat an OpenAI organization needs beyond the issuer and subject.
Show propertiesHide properties
audiencestringrequiredThe `aud` of tokens exchanged at OpenAI, and the audience to give the
workload identity provider.
subjectstringrequiredThe `sub` claim of this workspace's tokens, and of no other
workspace's: the value a role's trust policy, a federation rule's
`subject_prefix`, or an OpenAI mapping's `sub` pins.
400A malformed workspace header, or a user caller with no workspace header.
errorErrorDetailrequiredWhat went wrong: a `code` to branch on and a `message` to show. The
message is written for a person and may change; the code will not.
Show propertiesHide properties
codeErrorCoderequiredThe machine-readable half of an error response, and the field a client
branches on. Closed: every error carries exactly one of these.
Allowed:
unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternalmessagestringrequired401Missing, malformed, or invalid bearer token.
errorErrorDetailrequiredWhat went wrong: a `code` to branch on and a `message` to show. The
message is written for a person and may change; the code will not.
Show propertiesHide properties
codeErrorCoderequiredThe machine-readable half of an error response, and the field a client
branches on. Closed: every error carries exactly one of these.
Allowed:
unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternalmessagestringrequired403Caller lacks model_provider.read, or an API key's Kikuvi-Workspace header names another workspace.
errorErrorDetailrequiredWhat went wrong: a `code` to branch on and a `message` to show. The
message is written for a person and may change; the code will not.
Show propertiesHide properties
codeErrorCoderequiredThe machine-readable half of an error response, and the field a client
branches on. Closed: every error carries exactly one of these.
Allowed:
unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternalmessagestringrequired404No such workspace, the caller cannot see it, or this deployment issues no workload identity.
errorErrorDetailrequiredWhat went wrong: a `code` to branch on and a `message` to show. The
message is written for a person and may change; the code will not.
Show propertiesHide properties
codeErrorCoderequiredThe machine-readable half of an error response, and the field a client
branches on. Closed: every error carries exactly one of these.
Allowed:
unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternalmessagestringrequired