List scope

GET 
/v2/config/digital-wallet/openid/sdjwt/scopes

Lists the OAuth 2.0 scopes available for OID4VCI credential issuance, as published in the Credential Issuer Metadata. Use a value from this list in credentialDefinitions[].scope of a create or update credential definition request, when authorizationRequestType is scope_based.

Request

Query Parameters

offset integerrequired

Default value: 0

Number of records to skip for pagination. A negative or unreadable value falls back to 0.

limit integerrequired

Default value: 10

Maximum number of records to return per page.

Header Parameters

X-SandboxOrgId stringrequired
Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.
The service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org instead.
X-SubwalletId is the deprecated name of this header. The service continues to accept it, but X-SandboxOrgId wins if you send both headers.
The sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.
Example: 6889e1a4c5b2f30001a3d710

Responses

200

The server returns the scopes for the current page.

Response Headers

application/json

Schema

Schema

scope object[]
Scopes for the current page. Each scope maps to a credential configuration in the OID4VCI Credential Issuer Metadata.
Array [
id stringrequired
Unique identifier for the scope record.
scope stringrequired
OAuth 2.0 scope value mapped to a credential type in the OID4VCI Credential Issuer Metadata.
createdAt numberrequired
Unix timestamp (in seconds) when the scope was created.
updatedAt numberrequired
Unix timestamp (in seconds) when the scope was last modified.
]
pagination object

currentPage integer

Current page number

totalItems integer

Total number of items available

totalPages integer

Total number of pages based on limit

limit integer

Number of items per page

hasPrevious boolean

Indicates if there's a previous page

hasNext boolean

Indicates if there's a next page

Example (from schema)

{
  "scope": [
    {
      "id": "string",
      "scope": "string",
      "createdAt": 0,
      "updatedAt": 0
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalItems": 25,
    "totalPages": 3,
    "limit": 10,
    "hasPrevious": false,
    "hasNext": true
  }
}

400

The organisation is unknown, the wallet is not deployed, or the issuer cannot read the scopes.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...