GET
Retrieves information about a user role
[tags: RPRM]
Request
Query Parameters
| Name |
Type |
Description |
|
|
|
| type |
xs:string |
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.
The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.
Note 1: The URL form is https://{host}:{port}/api/rest/user-roles/{value}?type={user-role-identifier|user-role-uuid}
Note 2: If the "user-role-uuid" enumeration is specified, then the value should correspond to the user-role-uuid.
Otherwise, the resource cannot not be found.
Note 3: If the "user-role-identifier" enumeration is specified, the the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "user-role-identifier" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=user-role-identifier", is not required.
|
Response
DELETE
Deletes information about a role
[tags: RPRM]
Request
Query Parameters
| Name |
Type |
Description |
|
|
|
| type |
xs:string |
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.
The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.
Note 1: The URL form is https://{host}:{port}/api/rest/user-roles/{value}?type={user-role-identifier|user-role-uuid}
Note 2: If the "user-role-uuid" enumeration is specified, then the value should correspond to the user-role-uuid.
Otherwise, the resource cannot not be found.
Note 3: If the "user-role-identifier" enumeration is specified, the the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "user-role-identifier" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=user-role-identifier", is not required.
|
Response
PUT
Updates information about a role account. Note: The password cannot be updated through this API.
[tags: RPRM]
Request
Query Parameters
| Name |
Type |
Description |
|
|
|
| type |
xs:string |
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.
The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.
Note 1: The URL form is https://{host}:{port}/api/rest/user-roles/{value}?type={user-role-identifier|user-role-uuid}
Note 2: If the "user-role-uuid" enumeration is specified, then the value should correspond to the user-role-uuid.
Otherwise, the resource cannot not be found.
Note 3: If the "user-role-identifier" enumeration is specified, the the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "user-role-identifier" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=user-role-identifier", is not required.
|
Representations
Response
|