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
oneOfOpenAPI 3 specification to facilitate multiple Grant types. - With
management-api-principal-cross-user-arrangement-accessset to true, clients will be able to pass inuserId= "ALL", which allows actions to be carried out on all users of the specifiedprincipalId(see Feature Flags). - With
management-api-user-cross-principal-arrangement-accessset to true, clients will be able to pass inprincipalId= "ALL", which allows actions to be carried out on all principals of the specifieduserId(see Feature Flags).