Grant APIs

The following APIs can be used to interact with the grant in a multi-tenant implementation of the platform.

GET Query Grants

/grants/{scope}

Parameters

Name	Located in	Description	Required	Schema
scope	path		Yes	string
IDs	query	Search by grant identifiers	No	[ string ]
solutionId	query	Search by solution identifier	No	string
name	query	Search by name	No	string
tags	query	Search by one or more tags	No	[ string ]
roleId	query	Search by this grant's role	No	string
limit	query	Limit the number of returned values	No	integer

Responses

Code	Description	Schema
200	Success	ListResponse.Grant
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
429	Too many requests - indicates the user has sent too many requests in a given amount of time
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

POST Create a Grant in a Given Scope

/grants/{scope}

Parameters

Name	Located in	Description	Required	Schema
scope	path		Yes	string

Responses

Code	Description	Schema
201	Resource created
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
409	Conflict	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

GET Get a Grant

/grants/{scope}/{grantId}

Parameters

Name	Located in	Description	Required	Schema
scope	path		Yes	string
grantId	path	Grant identifier	Yes	string

Responses

Code	Description	Schema
200	Success	Grant
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Not found. One or more resources were not found, response may contain details about missing resources	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

PUT Update a Grant by Scope

/grants/{scope}/{grantId}

Parameters

Name	Located in	Description	Required	Schema
scope	path		Yes	string
grantId	path	Grant identifier	Yes	string

Responses

Code	Description	Schema
204	Success
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Not found. One or more resources were not found, response may contain details about missing resources	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

DELETE Delete a Grant

TIP

NOTE Possible only if no principals have this grant.

/grants/{scope}/{grantId}

Parameters

Name	Located in	Description	Required	Schema
scope	path	Scope	Yes	string
grantId	path	Grant identifier	Yes	string

Responses

Code	Description	Schema
204	Success
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Not found. One or more resources were not found, response may contain details about missing resources	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors