Skip to main content

Function: bindSubject()

bindSubject(key, where?): string

Defined in: packages/contracts/src/messages.ts:23

Turns a registry key into a concrete subject.

Parameters​

key​

"request.platform.identity.principal.resolve.v1" | "request.platform.identity.me.get.v1" | "request.*.identity.subject.create.v1" | "request.*.identity.subject.get.v1" | "request.platform.identity.bootstrap.apply.v1" | "request.*.identity.person.create.v1" | "request.*.identity.person.get.v1" | "request.*.identity.person.invite.v1" | "request.*.identity.grant.create.v1" | "request.*.identity.grant.revoke.v1" | "request.*.identity.grant.list.v1" | "event.*.identity.grant.revoked.v1" | "event.*.*.audit.recorded.v1" | "event.platform.gateway.audit.recorded.v1" | "event.platform.gateway-admin.audit.recorded.v1" | "event.platform.bootstrap.audit.recorded.v1" | "request.*.governance.accreditation.apply.v1" | "request.*.governance.accreditation.admit.v1" | "request.*.governance.accreditation.publish.v1" | "request.*.governance.accreditation.get.v1" | "request.*.governance.accreditation.list.v1" | "request.platform.governance.anchor.converge.v1" | "event.*.governance.accreditation.admitted.v1" | "event.*.governance.accreditation.publication-approved.v1" | "request.*.trust.entity-statement.list.v1" | "request.*.trust.entity-statement.preview.v1" | "event.*.trust.entity-statement.published.v1" | "request.*.issuance.identifier.create.v1" | "request.*.issuance.identifier.get.v1" | "request.*.issuance.identifier.list.v1" | "request.*.issuance.identifier.preview.v1" | "request.*.issuance.identifier.publish.v1" | "request.*.issuance.identifier.update.v1" | "request.platform.provisioning.agent.converge.v1" | "request.platform.issuance.registry.probe.v1" | "request.platform.issuance.identifier.converge.v1" | "request.platform.trust.key-store.probe.v1" | "request.platform.issuance.identifier.resolve.v1" | "request.platform.identity.root-sign-in.get.v1" | "event.*.issuance.identifier.requested.v1" | "event.*.provisioning.placement.changed.v1" | "event.*.issuance.identifier.published.v1"

A registry key.

where?​

tenant for a key with * in the tenant position (omit it for a platform key); module for an event key with * in the module position.

module?​

string

tenant?​

string

Returns​

string

The concrete subject.

Throws​

A needed part is missing, or a given one is malformed or contradicts the key (a tenant other than platform on a platform key).