Platform | Role

Service to manage entities of type 'Role'.

Overview

api/{tenantKey}/{orgKey}/identity/roles

URL	api/{tenantKey}/{orgKey}/identity/roles
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST UserRoles
PUT:
DELETE:
- DELETE Role by identifier
- DELETE Role by key

All Resources

This service uses the following resources:

ApiUserRolesResource
RoleResource

GET Operations

GET Roles

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See RoleResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles

GET /identity/roles

GET Roles (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See RoleResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles?page={page}&pageSize={pageSize}

GET /identity/roles?page={page}&pageSize={pageSize}

GET Role by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See RoleResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles/{id}

GET /identity/roles/{id}

GET Role by key

Returns the entity record that matches the specified key.

The following elements are required:

roleKey

(string) Role.

Response:

When successful, the response body contains the entity record. See RoleResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles/{roleKey}

GET /identity/roles/{roleKey}

GET Print Role by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles/{id}/print?template={template}

GET /identity/roles/{id}/print?template={template}

GET Print Role by key

Prints the specified entity record.

The following elements are required:

roleKey

(string) Role.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles/{roleKey}/print

GET /identity/roles/{roleKey}/print

GET Original Print RoleOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles/{id}/printOriginal?template={template}

GET /identity/roles/{id}/printOriginal?template={template}

GET Original Print Role by key

Prints the specified entity record.

The following elements are required:

roleKey

(string) Role.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles/{roleKey}/printOriginal

GET /identity/roles/{roleKey}/printOriginal

POST Operations

POST UserRoles

Creates a new entity record.

The following elements are required:

roleResource

(ApiUserRolesResource) The request body should contain the entity record that should be created.
See ApiUserRolesResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiUserRolesResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles

POST /identity/roles

PUT Operations

PUT Set Description Role

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

roleKey	(string) Role.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles/{roleKey}/description

PUT /identity/roles/{roleKey}/description

PUT Set IsActive Role

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

roleKey	(string) Role.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles/{roleKey}/isActive

PUT /identity/roles/{roleKey}/isActive

PUT Set IsAdministration Role

Updates the value of attribute 'IsAdministration' in the specified entity record.

The following elements are required:

roleKey	(string) Role.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles/{roleKey}/isAdministration

PUT /identity/roles/{roleKey}/isAdministration

PUT Set IsDefault Role

Updates the value of attribute 'IsDefault' in the specified entity record.

The following elements are required:

roleKey	(string) Role.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles/{roleKey}/isDefault

PUT /identity/roles/{roleKey}/isDefault

PUT Set IsInternal Role

Updates the value of attribute 'IsInternal' in the specified entity record.

The following elements are required:

roleKey	(string) Role.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles/{roleKey}/isInternal

PUT /identity/roles/{roleKey}/isInternal

PUT Set LocalizableDescription Role

Updates the value of attribute 'LocalizableDescription' in the specified entity record.

The following elements are required:

roleKey	(string) Role.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles/{roleKey}/localizableDescription

PUT /identity/roles/{roleKey}/localizableDescription

PUT Set RoleDefinition Role

Updates the value of attribute 'RoleDefinition' in the specified entity record.

The following elements are required:

roleKey	(string) Role.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles/{roleKey}/roleDefinition

PUT /identity/roles/{roleKey}/roleDefinition

PUT Set RoleKey Role

Updates the value of attribute 'RoleKey' in the specified entity record.

The following elements are required:

roleKey	(string) Role.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles/{roleKey}/roleKey

PUT /identity/roles/{roleKey}/roleKey

DELETE Operations

DELETE Role by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles/{id}

DELETE /identity/roles/{id}

DELETE Role by key

Deletes the entity record that matches the specified key.

The following elements are required:

roleKey

(string) Role.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/roles/{roleKey}

DELETE /identity/roles/{roleKey}

Resources

ApiUserRolesResource

The following elements are required:

roleKey	(string) Role.
description	(string) Description.
isAdministration	(bool) Is Administration.
isDefault	(bool) Is Default.
isInternal	(bool) Is Internal.

The following elements are optional:

localizableDescription	(string) Description.
roleDefinition	(string) Role Definition.

RoleResource

The following elements are required:

roleKey	(string) Role.
description	(string) Description.
isAdministration	(bool) Is Administration.
isDefault	(bool) Is Default.
isInternal	(bool) Is Internal.

The following elements are optional:

localizableDescription	(string) Description.
roleDefinition	(string) Role Definition.
users	(User) Users.