UserRole



[tags: RPRM]

Resource Root

https://localhost:8443/api/rest/user-roles

Summary


Resources Methods
https://localhost:8443/api/rest/user-roles

GET  Get the list of user role objects [tags: RPRM] .

POST  Creates a role.

https://localhost:8443/api/rest/user-roles/user-associated-roles

GET Get Associated roles of user.

https://localhost:8443/api/rest/user-roles/group-associated-roles

GET Get Associated roles of group.

https://localhost:8443/api/rest/user-roles/permissions

GET Get all permissions.

https://localhost:8443/api/rest/user-roles/{user-role}

GET  Retrieves information about a user role [tags: RPRM] .

DELETE  Deletes information about a role [tags: RPRM] .

PUT  Updates information about a role account.

https://localhost:8443/api/rest/user-roles/{user-role}/associated-permissions

POST Associate user permissions with role [tags: RPRM] .

GET Get associated permissions of role [tags: RPRM] .

Resources


https://localhost:8443/api/rest/user-roles


Methods

GET


Get the list of user role objects
[tags: RPRM]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-user-role-list+xml
application/vnd.plcm.plcm-user-role-list+json
User role list information successfully retrieved
304
User Role information has not changed since the last search.

Note: The API client must provide the "plcm-user-role-list" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.
The "plcm-user-role-list" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
users on the server.

POST


Creates a role.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-user-role+xml
application/vnd.plcm.plcm-user-role+json

Response

Status Representation Description
201 role created successfully.
400 text/plain
Bad request.
409 application/vnd.plcm.plcm-error+xml
The role already exists.
409 application/vnd.plcm.plcm-error+xml
role name is required.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role UUID must be empty.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role identifier must be empty.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
At least one System Role is required.

https://localhost:8443/api/rest/user-roles/user-associated-roles


Methods

GET

Get Associated roles of user.
[tags: RPRM]

Request

Query Parameters

Name Type Description
user-uuid xs:string

Response

Status Representation Description
200 application/vnd.plcm.plcm-user-role-list+xml
application/vnd.plcm.plcm-user-role-list+json
Get Associated roles of user successfully.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The user-uuid is required.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User can not be found by UUID.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
UUID is invalid.

https://localhost:8443/api/rest/user-roles/group-associated-roles


Methods

GET

Get Associated roles of group.
[tags: RPRM]

Request

Query Parameters

Name Type Description
group-uuid xs:string

Response

Status Representation Description
200 application/vnd.plcm.plcm-user-role-list+xml
application/vnd.plcm.plcm-user-role-list+json
Get Associated roles of group successfully.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The group-uuid is required.

https://localhost:8443/api/rest/user-roles/permissions


Methods

GET

Get all permissions.
[tags: RPRM]

Request

Query Parameters

Name Type Description
service xs:string service arg doc. PD,RPRM etc.

Response

Status Representation Description
200 application/vnd.plcm.plcm-user-role-permission-list+xml
application/vnd.plcm.plcm-user-role-permission-list+json
Get all permissions successfully.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role UUID is required.

https://localhost:8443/api/rest/user-roles/{user-role}


Template Parameters

Name Type Description
user-role xs:string user role uuid arg doc.Unique uuid or identifier of the role.

Methods

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

Status Representation Description
200 application/vnd.plcm.plcm-user-role+xml
application/vnd.plcm.plcm-user-role+json
User role information successfully retrieved
304
User role information has not changed since the last retrieval.
Note: The API client must provide the "plcm-user-role" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional
retrieval. This will improve network performance by reducing bandwidth
consumption.

If the API client chooses to exclude an ETag value from a previous,
identical single user role retrieval in the "If-None-Match" header, then
the HTTP response will contain the user role representation in the message
body.

The "plcm-user-role" ETag can be accessed from the initial retrieval result's HTTP
response header. Also, subsequent retrievals require the identical user role
to ensure an equivalent ETag value. This also assumes no other client made changes to
users on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator, provisioner
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Users in the LOCAL domain are not allowed access to information in the enterprise directory.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such user role
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Key value is required.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role was not found.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role ID is invalid.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role can not be found by UUID.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
UUID is invalid.

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

Status Representation Description
204 role information successfully deleted
403 application/vnd.plcm.plcm-error+xml
Unable to get permission. User roles required: administrator, provisioner
404 application/vnd.plcm.plcm-error+xml
No such role.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role UUID is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role is predefined,it cannot be modified.

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

application/vnd.plcm.plcm-user-role+xml
application/vnd.plcm.plcm-user-role+json

Response

Status Representation Description
204
role information successfully updated.
Note: The response will only contain both an ETag value
and link to the updated role resource.
400 text/plain
Bad request.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission. User roles required: administrator, provisioner
404 application/vnd.plcm.plcm-error+xml
No such role.
412 application/vnd.plcm.plcm-error+xml

The role resource has changed on the server.

Note: The response will contain the ETag value and link that reflects
the server's role resource in the HTTP response header.

The API client must supply the ETag in the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-user-role.xsd" for details.
If the message body does not contain the ETag value, the server will
look for the ETag in the "If-Match" header.
428 application/vnd.plcm.plcm-error+xml

The API client must supply the ETag in the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-user-role.xsd" for details.
If the message body does not contain the ETag value, the server will
look for the ETag in the "If-Match" header.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role UUID is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role name cannot be modified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role is predefined,it cannot be modified.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role was not found.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role ID is invalid.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role can not be found by UUID.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
UUID is invalid.

https://localhost:8443/api/rest/user-roles/{user-role}/associated-permissions


Template Parameters

Name Type Description
user-role xs:string user role uuid arg doc.Unique uuid or identifier of the role.

Methods

POST

Associate user permissions with role
[tags: RPRM]

Request

Query Parameters

Name Type Description
service xs:string service arg doc. PD,RPRM etc.
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

application/vnd.plcm.plcm-string-list+xml
application/vnd.plcm.plcm-string-list+json

Response

Status Representation Description
204 Associate permissions with role successfully.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role UUID is required.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Permission ID is not legal, please do get permissions operation firstly to refer them.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Permission ID is not found.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role is predefined,it cannot be modified.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role was not found.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role ID is invalid.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role can not be found by UUID.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
UUID is invalid.

GET

Get associated permissions of role
[tags: RPRM]

Request

Query Parameters

Name Type Description
service xs:string service arg doc. PD,RPRM etc.
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

Status Representation Description
200 application/vnd.plcm.plcm-user-role-permission-list+xml
application/vnd.plcm.plcm-user-role-permission-list+json
Get associated permissions of role successfully.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role UUID is required.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role was not found.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role ID is invalid.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User role can not be found by UUID.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
UUID is invalid.