Group



[tags: RPRM]

Resource Root

https://localhost:8443/api/rest/groups

Summary


Resources Methods
https://localhost:8443/api/rest/groups

GET  Get the list of group information objects of type LDAP [tags: RPRM] .

POST  Creates a group.

https://localhost:8443/api/rest/groups/enterprise-groups

POST  import enterprise groups.

GET  Get the list of group information objects of enterprise groups [tags: RPRM] .

https://localhost:8443/api/rest/groups/{group-identifier}

GET  Retrieves group with passed id.

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

PUT  Updates information about a group account.

https://localhost:8443/api/rest/groups/{group-identifier}/associated-roles

GET Get associated role-uuids of group.

POST Associate roles with group.

https://localhost:8443/api/rest/groups/{group-identifier}/group-members

GET  Retrieves group member with passed id.

PUT  Updates information about a group member account.

https://localhost:8443/api/rest/groups/{group-identifier}/group-members/available-members

GET  Retrieves available group member with query string.

Resources


https://localhost:8443/api/rest/groups


Methods

GET


Get the list of group information objects of type LDAP
[tags: RPRM]

Request

Response

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

Note: The API client must provide the "plcm-group-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-group-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 group.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-group+xml
application/vnd.plcm.plcm-group+json

Response

Status Representation Description
201 group created successfully.
400 application/vnd.plcm.plcm-error+xml
group UUID is invalid.
400 application/vnd.plcm.plcm-error+xml
Group Name length exceeds the maximum.
400 application/vnd.plcm.plcm-error+xml
Group Name can't be empty.
400 application/vnd.plcm.plcm-error+xml
Group UUID can not be initialized when creating a group.
409 application/vnd.plcm.plcm-error+xml
The group name already exists.

https://localhost:8443/api/rest/groups/enterprise-groups


Methods

POST


import enterprise groups.
[tags: RPRM]

Request

Representations

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

Response

Status Representation Description
204 groups imported successfully.
400 application/vnd.plcm.plcm-error+xml
group UUID is invalid.
400 text/plain
The input parameter group uuid list is required.
404 application/vnd.plcm.plcm-error+xml
No such group.

GET


Get the list of group information objects of enterprise groups
[tags: RPRM]

Request

Query Parameters

Name Type Description
search-string xs:string Return only enterprise groups that match the queryString.

Response

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

Note: The API client must provide the "plcm-group-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-group-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.
400 text/plain
Search string is required.

https://localhost:8443/api/rest/groups/{group-identifier}


Template Parameters

Name Type Description
group-identifier xs:string

Methods

GET


Retrieves group with passed id. The id could be either integer or uuid which is specified by the type.
[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/groups/{group-identifier}?type={group-identifier|group-uuid}
Note 2: If the "group-uuid" enumeration is specified, then the value should correspond to the group-uuid.
Otherwise, the resource cannot not be found.
Note 3: If the "group-identifier" enumeration is specified, the the value should correspond to the group-identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "group-identifier" type enumeration. As a result, the {group-identifier} parameter
can simply specify the unique identifier and the query parameter, "?type=group-identifier", is not required.

Response

Status Representation Description
200 application/vnd.plcm.plcm-group+xml
application/vnd.plcm.plcm-group+json
Group successfully retrieved
304
Group information has not changed since the last search.

Note: The API client must provide the "plcm-group" 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-group" 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.
400 application/vnd.plcm.plcm-error+xml
group UUID is invalid.
404 application/vnd.plcm.plcm-error+xml
No such group.

DELETE


Deletes information about a group
[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/groups/{group-identifier}?type={group-identifier|group-uuid}
Note 2: If the "group-uuid" enumeration is specified, then the value should correspond to the group-uuid.
Otherwise, the resource cannot not be found.
Note 3: If the "group-identifier" enumeration is specified, the the value should correspond to the group-identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "group-identifier" type enumeration. As a result, the {group-identifier} parameter
can simply specify the unique identifier and the query parameter, "?type=group-identifier", is not required.

Response

Status Representation Description
204 group information successfully deleted
400 application/vnd.plcm.plcm-error+xml
group UUID is invalid.
400 application/vnd.plcm.plcm-error+xml
Group Name can't be empty.
400 application/vnd.plcm.plcm-error+xml
Group UUID can not be empty when updating a group.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission. User roles required: administrator, provisioner
403 application/vnd.plcm.plcm-error+xml
Unable to delete group for it is in an access control list.
404 application/vnd.plcm.plcm-error+xml
No such group.

PUT


Updates information about a group 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/groups/{group-identifier}?type={group-identifier|group-uuid}
Note 2: If the "group-uuid" enumeration is specified, then the value should correspond to the group-uuid.
Otherwise, the resource cannot not be found.
Note 3: If the "group-identifier" enumeration is specified, the the value should correspond to the group-identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "group-identifier" type enumeration. As a result, the {group-identifier} parameter
can simply specify the unique identifier and the query parameter, "?type=group-identifier", is not required.

Representations

application/vnd.plcm.plcm-group+xml
application/vnd.plcm.plcm-group+json

Response

Status Representation Description
204
group information successfully updated.
Note: The response will only contain both an ETag value
and link to the updated group resource.
400 application/vnd.plcm.plcm-error+xml
group UUID is invalid.
400 application/vnd.plcm.plcm-error+xml
Group Name can't be empty.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission. User roles required: administrator, provisioner
403 application/vnd.plcm.plcm-error+xml
Failed to update enterprise group.
404 application/vnd.plcm.plcm-error+xml
No such group.
412 application/vnd.plcm.plcm-error+xml

The group resource has changed on the server.

Note: The response will contain the ETag value and link that reflects
the server's group 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-group.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-group.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.

https://localhost:8443/api/rest/groups/{group-identifier}/associated-roles


Template Parameters

Name Type Description
group-identifier xs:string

Methods

GET

Get associated role-uuids of group.
[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/groups/{group-identifier}?type={group-identifier|group-uuid}
Note 2: If the "group-uuid" enumeration is specified, then the value should correspond to the group-uuid.
Otherwise, the resource cannot not be found.
Note 3: If the "group-identifier" enumeration is specified, the the value should correspond to the group-identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "group-identifier" type enumeration. As a result, the {group-identifier} parameter
can simply specify the unique identifier and the query parameter, "?type=group-identifier", is not required.

Response

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

POST

Associate roles with group. Input role id list.
[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/groups/{group-identifier}?type={group-identifier|group-uuid}
Note 2: If the "group-uuid" enumeration is specified, then the value should correspond to the group-uuid.
Otherwise, the resource cannot not be found.
Note 3: If the "group-identifier" enumeration is specified, the the value should correspond to the group-identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "group-identifier" type enumeration. As a result, the {group-identifier} parameter
can simply specify the unique identifier and the query parameter, "?type=group-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 roles with group successfully.
400 application/vnd.plcm.plcm-error+xml
group UUID is invalid.
400 application/vnd.plcm.plcm-error+xml
Group UUID can not be empty when associating roles to a group.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.
403 application/vnd.plcm.plcm-error+xml
Associate roles to un-integrated AD group is not allowed.
404 application/vnd.plcm.plcm-error+xml
No such group.

https://localhost:8443/api/rest/groups/{group-identifier}/group-members


Template Parameters

Name Type Description
group-identifier xs:string

Methods

GET


Retrieves group member with passed id.
[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/groups/{group-identifier}?type={group-identifier|group-uuid}
Note 2: If the "group-uuid" enumeration is specified, then the value should correspond to the group-uuid.
Otherwise, the resource cannot not be found.
Note 3: If the "group-identifier" enumeration is specified, the the value should correspond to the group-identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "group-identifier" type enumeration. As a result, the {group-identifier} parameter
can simply specify the unique identifier and the query parameter, "?type=group-identifier", is not required.

Response

Status Representation Description
200 application/vnd.plcm.plcm-group-member-detail+xml
application/vnd.plcm.plcm-group-member-detail+json
Group members successfully retrieved
304
Group members information has not changed since the last search.

Note: The API client must provide the "plcm-group-member-detail" 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-group-member" 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.
400 application/vnd.plcm.plcm-error+xml
group UUID is invalid.
404 application/vnd.plcm.plcm-error+xml
No such group.

PUT


Updates information about a group member account.
[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/groups/{group-identifier}?type={group-identifier|group-uuid}
Note 2: If the "group-uuid" enumeration is specified, then the value should correspond to the group-uuid.
Otherwise, the resource cannot not be found.
Note 3: If the "group-identifier" enumeration is specified, the the value should correspond to the group-identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "group-identifier" type enumeration. As a result, the {group-identifier} parameter
can simply specify the unique identifier and the query parameter, "?type=group-identifier", is not required.

Representations

application/vnd.plcm.plcm-group-member+xml
application/vnd.plcm.plcm-group-member+json

Response

Status Representation Description
204
group member information successfully updated.
Note: The response will only contain both an ETag value
and link to the updated group member resource.
400 application/vnd.plcm.plcm-error+xml
group UUID is invalid.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission. User roles required: administrator
404 application/vnd.plcm.plcm-error+xml
No such group member.
404 application/vnd.plcm.plcm-error+xml
No such group.
412 application/vnd.plcm.plcm-error+xml

The group member resource has changed on the server.

Note: The response will contain the ETag value and link that reflects
the server's group member 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-group-member.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-group-member.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.

https://localhost:8443/api/rest/groups/{group-identifier}/group-members/available-members


Template Parameters

Name Type Description
group-identifier xs:string

Methods

GET


Retrieves available group member with query string.
[tags: RPRM]

Request

Query Parameters

Name Type Description
search-string xs:string Return only group members that match the queryString.
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/groups/{group-identifier}?type={group-identifier|group-uuid}
Note 2: If the "group-uuid" enumeration is specified, then the value should correspond to the group-uuid.
Otherwise, the resource cannot not be found.
Note 3: If the "group-identifier" enumeration is specified, the the value should correspond to the group-identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "group-identifier" type enumeration. As a result, the {group-identifier} parameter
can simply specify the unique identifier and the query parameter, "?type=group-identifier", is not required.

Response

Status Representation Description
200 application/vnd.plcm.plcm-group-member-detail+xml
application/vnd.plcm.plcm-group-member-detail+json
Group member successfully retrieved
304
Group members information has not changed since the last search.

Note: The API client must provide the "plcm-group-member" 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-group-member" 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.
400 text/plain
Search string is required.