Skip to main content

AcquireLimitedAccessTokenInput

Input for acquiring a limited access token.

input AcquireLimitedAccessTokenInput {
  allowAnonymousPresentation: Boolean
  callback: Callback
  identityId: ID
  issuableContractIds: [String!]
  listContracts: Boolean
  requestableCredentials: [RequestedCredentialSpecificationInput!]
}

Fields​

AcquireLimitedAccessTokenInput.allowAnonymousPresentation ● Boolean scalar​

If true, the limited access token can be used to request presentations of credentials from any identity (identityId is not required).

  • The app acquiring the token must be granted the VerifiableCredential.AcquireLimitedAccessToken.AnonymousPresentations role

AcquireLimitedAccessTokenInput.callback ● Callback input​

Defines the callback for credential issuance or presentation operations made via the limited access token.

AcquireLimitedAccessTokenInput.identityId ● ID scalar​

The ID of the (issuee) identity to which access will be limited.

The ID is required in all limited access scenarios except anonymous presentations (allowAnonymousPresentation).

The ID, if supplied:

  • will be used for issuance requests: limited access tokens can only be used to issue credentials to a fixed single identity specified at token acquisition time
  • must match the identity ID in presented credentials
  • will be saved as the identity of the presentation of partner credentials (useful when the presenter identity is known via authentication or other means)
  • must match that used in criteria when querying presentation, issuance or identity data; or when subscribing to issuance or presentation events

AcquireLimitedAccessTokenInput.issuableContractIds ● [String!] list scalar​

The ID(s) of the contract(s) that can be issued.

  • The app acquiring the token must be granted the VerifiableCredential.AcquireLimitedAccessToken.Issue role
  • identityId must also be specified (limited access tokens can only be used to issue credentials to a fixed single identity)

AcquireLimitedAccessTokenInput.listContracts ● Boolean scalar​

If true, the limited access token can be used to list contracts via Query.findContracts

  • The app acquiring the token must be granted the VerifiableCredential.AcquireLimitedAccessToken.ListContracts role
  • Note: issuances and presentations of the contracts can be queried if a matching identityId is also supplied as criteria

AcquireLimitedAccessTokenInput.requestableCredentials ● [RequestedCredentialSpecificationInput!] list input​

Defines the types of credentials that can requested for presentation.

  • The app acquiring the token must be granted the VerifiableCredential.AcquireLimitedAccessToken.Present role

Member Of​

acquireLimitedAccessToken mutation