Role APIs

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

GET Query Roles

/roles/{scope}

Parameters

Name	Located in	Description	Required	Schema
scope	path		Yes	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 ]
permission	query		No	string
limit	query	Limit the number of returned values	No	integer

Responses

Code	Description	Schema
200	Success	ListResponse.Role
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 Role in a Given Scope

/roles/{scope}

Parameters

Name	Located in	Description	Required	Schema
scope	path		Yes	string

Responses

Code	Description	Schema
201	Resource created	InlineResponse201
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 Role

/roles/{scope}/{roleId}

Parameters

Name	Located in	Description	Required	Schema
scope	path		Yes	string
roleId	path	Role identifier	Yes	string

Responses

Code	Description	Schema
200	Success	Role
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

PUT Update a Role

/roles/{scope}/{roleId}

Parameters

Name	Located in	Description	Required	Schema
scope	path		Yes	string
roleId	path	Role 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
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

DELETE Delete a Role

NOTE

Allowed only if there are no grants using this role.

/roles/{scope}/{roleId}

Parameters

Name	Located in	Description	Required	Schema
scope	path		Yes	string
roleId	path	Role 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