Skip to main content

List Grants

This endpoint is used to list Grants stored within the HaaS environment.

Purpose​

The purpose of this endpoint is to provide a list of the Grants associated with Consumers. This is ostensibly CDR Arrangements but will eventually expand as the CDR introduces additional functionality.

Management API​

List Grants​

Loading...

Β 

Important

The List Grants endpoint has historically been at /{'principalId'} and this endpoint remains available but classified as deprecated.

Data Adapter Endpoint​

N/A

Endpoint Specific Guidance​

  • The GitBook renderer of this endpoint is not fully functional because it uses oneOf with a discriminator.
  • This is one of the first endpoints to utilise oneOf OpenAPI 3 specification to facilitate multiple Grant types.
  • With management-api-principal-cross-user-arrangement-access set to true, clients will be able to pass in userId = "ALL", which allows actions to be carried out on all users of the specified principalId (see Feature Flags).
  • With management-api-user-cross-principal-arrangement-access set to true, clients will be able to pass in principalId = "ALL", which allows actions to be carried out on all principals of the specified userId (see Feature Flags).