Introduction
This is the REST API for the Content Manager module of Videoscape Media Suite. Methods can be accessed using the following base URL:
http(s)://{VMS URL}/opencase/resource/rest{Method Mount Point}
REST
This API supports a Representational State Transfer (REST) model for accessing a set of resources through a fixed set of operations. The following resources are accessible through the RESTful model:
- /api/admin/v1/permission/ui/{uuid}
- /api/admin/v1/permission/ui
- /api/admin/v1/menu
- /api/admin/v1/role/{uuid}
- /api/admin/v1/role
- /api/admin/v1/permission/api/{uuid}
- /api/admin/v1/permission/api
- /api/admin/v1/restrictionkey/{uuid}
- /api/admin/v1/restrictionkey
- /api/admin/v1/administrator/{username}
- /api/admin/v1/administrator
- /api/admin/v1/locales
- /api/admin/v2/administrator/{username}
- /api/admin/v2/administrator
- /api/admin/v1/configuration/{uuid}
- /api/admin/v1/configuration/
- /api/auth
- /api/auth/cookiename
- /api/admin/v1/caching/{nameid}
- /api/admin/v1/caching
Data
All endpoints act on a common set of data. The data can be represented in different data formats (i.e. MIME types), depending on the endpoint that consumes and/or produces the data. The data format is JSON.
JSON Data Types
/api/admin/v1/permission/ui/{uuid}
- Mount point: /api/admin/v1/permission/ui/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific instance of the DTO given the UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
PermissionDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
/api/admin/v1/permission/ui
- Mount point: /api/admin/v1/permission/ui
The following operations are supported on this resource:
GET
This method is used to get list of available Permission DTO objects by given optional query parameters. See API Search page for parameters description.
URL Parameters
name | description | type | default |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
PermissionDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/admin/v1/menu
- Mount point: /api/admin/v1/menu
The following operations are supported on this resource:
GET
This method is used to get list of available Menu Item DTO objects by given optional query parameters. Search, Sort and Pagination are not supported for this API.
URL Parameters
name | description | type | default |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
MenuItemDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/admin/v1/role/{uuid}
- Mount point: /api/admin/v1/role/{uuid}
The following operations are supported on this resource:
DELETE
This method is used to delete Role by provided uuid.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT. Role was successfully deleted. |
404 | NOT FOUND. Role with provided id was not found. |
405 | NOT ALLOWED. Deletion is not allowed for Role with provided id. |
GET
This method is used to get a specific instance of the DTO by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
RoleDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
PUT
This method is used to perform update or partial update of Role.
UUID: Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string. Name of the Role is not updatable and must be skipped.Only Roles with is_delete_allowed flag = true are available for update.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the Role. | path |
Input Payload
element | consumeable content type(s) |
---|---|
RoleDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
RoleDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or entity didn't pass field validation. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body, or is_delete_allowed = false. |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
/api/admin/v1/role
- Mount point: /api/admin/v1/role
The following operations are supported on this resource:
POST
This method is used to create new Role.
Uuid must not be specified for this operation. Name field is required. Name must not contain spaces or special symbols. Array of Permissions and APIPermissions references may be specified or left blank
Input Payload
element | consumeable content type(s) |
---|---|
RoleDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
RoleDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request is formed correctly, but server cannot perform entity creation. Unexpected error. |
GET
This method is used to get list of available Role DTO objects by given optional query parameters. See API Search page for parameters description.
Roles available for task assignment may be gotten by next search token: is_task_actor:equals:true
URL Parameters
name | description | type | default |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
RoleDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/admin/v1/permission/api/{uuid}
- Mount point: /api/admin/v1/permission/api/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific instance of the DTO by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
APIPermissionDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
/api/admin/v1/permission/api
- Mount point: /api/admin/v1/permission/api
The following operations are supported on this resource:
GET
This method is used to get list of available APIPermission DTO objects by given optional query parameters. See API Search page for parameters description.
URL Parameters
name | description | type | default |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
APIPermissionDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/admin/v1/restrictionkey/{uuid}
- Mount point: /api/admin/v1/restrictionkey/{uuid}
The following operations are supported on this resource:
DELETE
This method is used to delete Restriction Key by provided uuid.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT. Restriction Key was successfully deleted. |
404 | NOT FOUND. Restriction Key with provided id was not found. |
405 | NOT ALLOWED. Deletion is not allowed for Restriction Key with provided id. |
PUT
This method is used to perform update Restriction Key.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the Role. | path |
Input Payload
element | consumeable content type(s) |
---|---|
RestrictionKeyDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
RestrictionKeyDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or entity didn't pass field validation. |
404 | UUID from request is not found in DB. |
405 | NOT ALLOWED. Updating is not allowed for Restriction Key with provided id. |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
/api/admin/v1/restrictionkey
- Mount point: /api/admin/v1/restrictionkey
The following operations are supported on this resource:
POST
This method is used to create new Restriction Key.
Input Payload
element | consumeable content type(s) |
---|---|
RestrictionKeyDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
RestrictionKeyDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or entity didn't pass field validation. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request is formed correctly, but server cannot perform entity creation. Unexpected error. |
GET
Returns list of restriction keys, for getting all published keys: ?search=is_published:in:true
URL Parameters
name | description | type | default |
---|---|---|---|
search | Search | query | |
sort | Restriction sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
RestrictionKeyDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
500 | Internal server error |
/api/admin/v1/administrator/{username}
- Mount point: /api/admin/v1/administrator/{username}
The following operations are supported on this resource:
DELETE
This method is used to delete user by given username.
URL Parameters
name | description | type | default |
---|---|---|---|
username | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT FOUND |
GET
This method is used to get a specific instance of the DTO by given username.
URL Parameters
name | description | type | default |
---|---|---|---|
username | The administrator username to obtain. | path |
Output Payload
element | produceable content type(s) |
---|---|
UserDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
PUT
This method is used to update user. Note, that username in request string must be present.
Note, that in PUT operation we must provide all required fields.
URL Parameters
name | description | type | default |
---|---|---|---|
username | The username. | path |
Input Payload
element | consumeable content type(s) |
---|---|
UserDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
UserDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | User with username from request is not found. |
405 | Request path has no username. |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
/api/admin/v1/administrator
- Mount point: /api/admin/v1/administrator
The following operations are supported on this resource:
POST
This method is used to create new user. Username must not be specified for this operation in the Url. Request body must contain all required fields.
Input Payload
element | consumeable content type(s) |
---|---|
UserDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
UserDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | Username is present in request path. |
500 | Request is formed correctly, but server cannot create entity. Unexpected error. |
GET
This method is used to get list of available user DTO objects. API search is not supported. API Sort allows to sort users by json fieldnames (except password, roles_ref)
URL Parameters
name | description | type | default |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
UserDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/admin/v1/locales
- Mount point: /api/admin/v1/locales
The following operations are supported on this resource:
GET
This method is used to get list of allowed locales which are supported. Search, Sort and Pagination are not supported for this API.
URL Parameters
name | description | type | default |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
LocaleConfigDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/admin/v2/administrator/{username}
- Mount point: /api/admin/v2/administrator/{username}
The following operations are supported on this resource:
GET
This method is used to get a specific instance of the DTO by given username.
URL Parameters
name | description | type | default |
---|---|---|---|
username | The username to obtain. | path |
Output Payload
element | produceable content type(s) |
---|---|
UserV2DTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
PUT
This method is used to update user. Username can be specified for this operation in the Url or in the body
Note, that in PUT operation we must provide all required fields.
URL Parameters
name | description | type | default |
---|---|---|---|
username | The username. | path |
Input Payload
element | consumeable content type(s) |
---|---|
UserV2DTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
UserV2DTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | User with username from request is not found. |
405 | Request path has no username. |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
DELETE
This method is used to delete user by given username.
URL Parameters
name | description | type | default |
---|---|---|---|
username | The username. | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT FOUND |
/api/admin/v2/administrator
- Mount point: /api/admin/v2/administrator
The following operations are supported on this resource:
POST
This method is used to create new user. Username must not be specified for this operation in the Url. Request body must contain all required fields.
Input Payload
element | consumeable content type(s) |
---|---|
UserV2DTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
UserV2DTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | Username is present in request path. |
500 | Request is formed correctly, but server cannot create entity. Unexpected error. |
/api/admin/v1/configuration/{uuid}
- Mount point: /api/admin/v1/configuration/{uuid}
The following operations are supported on this resource:
DELETE
This method is used to perform delete of the Config
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT. Config was successfully deleted. |
404 | NOT FOUND. Config was not found. |
405 | NOT ALLOWED. Deleting config is not allowed. |
GET
This method is used to get a specific instance of the DTO by given the UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
ConfigDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
PUT
This method is used to perform update and partial update of the Config
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the Config. | path |
Input Payload
element | consumeable content type(s) |
---|---|
ConfigDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ConfigDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | error in JSON request, or entity didn't pass field validation |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
/api/admin/v1/configuration/
- Mount point: /api/admin/v1/configuration/
The following operations are supported on this resource:
POST
This method is used to create new Config at child level. Note that Configuation is not allowed to create at root level.
Input Payload
element | consumeable content type(s) |
---|---|
ConfigDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ConfigDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
GET
This method is used to get list of available Config DTO objects by given optional query parameters. See API Search page for parameters description.
URL Parameters
name | description | type | default |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
ConfigDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/auth
- Mount point: /api/auth
The following operations are supported on this resource:
POST
This method is used to get an authentication token. Request body must contain login/password information.
Input Payload
element | consumeable content type(s) |
---|---|
AuthCredentialsDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
AuthTokenDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Created. |
400 | Error in JSON request or credentials are missing. |
404 | Request path formed incorrectly and cannot be resolved. |
500 | Request is formed correctly, but server cannot create entity. Unexpected error. |
GET
This method is used to get authentication token by its value. Value should be defined in request header.
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
200 | Existed Token |
404 | NOT FOUND |
DELETE
This method is used to logout user by its value. Value should be defined in request header.
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
200 | NO CONTENT |
404 | NOT FOUND |
/api/auth/cookiename
- Mount point: /api/auth/cookiename
The following operations are supported on this resource:
GET
This method is used to get authentication token cookie name.
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
200 | Token cookie name |
404 | NOT FOUND |
/api/admin/v1/caching/{nameid}
- Mount point: /api/admin/v1/caching/{nameid}
The following operations are supported on this resource:
DELETE
This method is used to clear a Cache Instance from the system provided the nameid of the Cache Instance.
URL Parameters
name | description | type | default |
---|---|---|---|
nameid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT. Cache Instance was successfully cleared. |
404 | NOT FOUND. Category with provided id was not found. |
GET
This method is used to get a specific instance Cache Instance DTO by given nameid.
URL Parameters
name | description | type | default |
---|---|---|---|
nameid | The name of the cache. | path |
Output Payload
element | produceable content type(s) |
---|---|
CacheManagementDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
/api/admin/v1/caching
- Mount point: /api/admin/v1/caching
The following operations are supported on this resource:
GET
This method is used to get a list of Cache Instance in the system
URL Parameters
name | description | type | default |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
CacheManagementDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
Type APIPermissionDTO
JSON object description
name | type | required | description |
---|---|---|---|
permission_type | string | false | [READ_ONLY] The api permission type |
api_node | string | false | [READ_ONLY] The api node of the API Permission |
uuid | string | false | [READ_ONLY] The uuid of the API Permission |
Type AuthCredentialsDTO
JSON object description
name | type | required | description |
---|---|---|---|
credentials | Credentials | false | Credentials containing login/password information |
Type AuthTokenDTO
JSON object description
name | type | required | description |
---|---|---|---|
authToken | AuthenticationToken | false |
Type AuthenticationToken
JSON object description
name | type | required | description |
---|---|---|---|
user_name | string | false | Authenticated user name |
issue_timestamp | Date | false | Date of authentication token issue |
token_value | string | false | Authentication token value |
roles | string | false | Authenticated user roles (comma separated roles) |
expiry_timestamp | Date | false | Date of authentication token expiration |
Type CacheManagementDTO
JSON object description
name | type | required | description |
---|---|---|---|
cache_name | string | false | [READ_ONLY] The Cache Instance |
module | string | false | [READ_ONLY] The module of the Cache Instance |
uuid | string | false |
Type ConfigDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_removable | boolean | false | [READ_ONLY_AFTER_CREATION] Boolean flag indicating, that config can be removed or not. default value is true |
is_encrypted | boolean | false | If the value of Configuration (entry attribute) is encrypted |
entry | string | false | The name of the Config |
description_key | string | false | The key of description in properties file |
child_config_refs | Set | false | [READ_ONLY] The references on child configuration objects |
validator_config | string | false | The configuration for validator of value (entry attribute) |
description | string | false | The description of the Config |
parent_config_ref | DTOReference | false | The reference on parent configuration object |
name | string | false | [REQUIRED] The name of the Config |
children_allowed | boolean | false | If the children configurations are allowed |
uuid | string | false | [READ_ONLY] The uuid of the Category |
Type Credentials
JSON object description
name | type | required | description |
---|---|---|---|
user_name | string | false | User's username |
password | string | false | User's password |
Type DTOReference
JSON object description
name | type | required | description |
---|---|---|---|
href | string | false | The url that references the other DTO |
name | string | false | The name of the referenced DTO |
uuid | string | false | [REQUIRED] The uuid of the referenced DTO |
Type DTOResourceBundle
JSON object description
name | type | required | description |
---|---|---|---|
resource_labels | Set | false | The Resource Labels (language, label) pair corresponding to the resource key |
resource_key | string | true | [REQUIRED] The resource key of the resource labels |
Type LocaleConfigDTO
JSON object description
name | type | required | description |
---|---|---|---|
locale | string | false | [READ_ONLY] The locale |
Type MenuItemDTO
JSON object description
name | type | required | description |
---|---|---|---|
child_menu_items | Array[MenuItemDTO] | false | Child Menu Items |
name | string | false | The name of the Menu Item |
link_url | string | false | The link to the Menu Item |
Type PermissionDTO
JSON object description
name | type | required | description |
---|---|---|---|
action | string | true | [REQUIRED] The action of the Permission |
target | string | true | [REQUIRED] The target of the Permission |
child_permissions_ref | Set | false | [READ_ONLY] The references on child permission objects |
parent_permission_ref | DTOReference | false | [READ_ONLY_AFTER_CREATION] The reference on parent permission object |
resource_bundle | DTOResourceBundle | true | [REQUIRED] The resource bundle |
uuid | string | false | [READ_ONLY] The uuid of the Permission |
Type RestrictionKeyDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_published | boolean | false | Shows if Restriction Key is published |
restriction_key | string | false | [REQUIRED] The Restriction Key value |
uuid | string | false | [READ_ONLY] The uuid of the Restriction Key |
Type RoleDTO
JSON object description
name | type | required | description |
---|---|---|---|
api_permissions_ref | Set | false | [GET_LIST_HIDDEN] The Set of references to APIPermissions See DTOReference |
is_delete_allowed | boolean | false | [READ_ONLY] Shows if Role could be deleted or updated. Default value for POST operations: true |
last_modified | Date | false | [READ_ONLY] Role's last modified date |
permissions_ref | Set | false | [GET_LIST_HIDDEN] The Set of references to Permissions See DTOReference |
role_name | string | false | [READ_ONLY_AFTER_CREATION] The name of the Role. Spaces or special symbols are not allowed |
uuid | string | false | [READ_ONLY] The uuid of the Role |
Type UserDTO
JSON object description
name | type | required | description |
---|---|---|---|
user_name | string | true | [REQUIRED] [READ_ONLY_AFTER_CREATION] The user name |
is_active | boolean | true | [REQUIRED] Shows if user is active or not |
roles_ref | Set | true | [REQUIRED] List of roles assigned to user |
password | string | true | [REQUIRED_ON_CREATION] Password of user. Should have at least 8 characters. This is a required property only on POST operations, if the password is empty or null on PUT operations, the password will simply be not updated |
locale | string | true | [REQUIRED] Defines the locale which will be used by user. For example en_US |
restriction_key | string | false | The restriction key of user |
string | false | Defines the email of user | |
is_admin | boolean | false | [READ_ONLY] Shows if user is administrator |
time_zone | string | true | [REQUIRED] Defines the time zone (id) which will be used by user. For example GMT+14 |
Type UserV2DTO
JSON object description
name | type | required | description |
---|---|---|---|
user_attributes | Set | false | Set of User's attributes |
role_names | Set | false | Set of user's rolenames |
login | string | true | [REQUIRED][READ_ONLY_AFTER_CREATION] The login of the User entity |