User



[tags: DMA,RPRM]

Resource Root

https://localhost:8443/api/rest/users

Summary


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

GET  Retrieves a list of users matching the input search filter parameters.

POST  Creates a local user account.

https://localhost:8443/api/rest/users/{domain}/{username}

GET  Retrieves information about a user account.

DELETE  Deletes information about a local user account.

PUT  Updates information about a user account.

https://localhost:8443/api/rest/users/self

GET  Retrieves information about logged in user account.

https://localhost:8443/api/rest/users/self/password

POST Changes password of the currently logged in user.

https://localhost:8443/api/rest/users/self/logout

DELETE Logs out the current user [tags: DMA].

https://localhost:8443/api/rest/users/self/login-history

GET Retrieves the login history of the calling user.

https://localhost:8443/api/rest/users/user-uuids

GET  Retrieves a list of user uuids in db.

https://localhost:8443/api/rest/users/authentication

POST Authenticate the user.

https://localhost:8443/api/rest/users/{value}

GET  Retrieves information about a user account.

PUT  Updates information about a user account.

https://localhost:8443/api/rest/users/{value}/associated-devices

GET Get associated deviceIds of user.

POST Associate devices to user with device id list.

https://localhost:8443/api/rest/users/{value}/associated-roles

GET Get associated role-uuids of user.

POST Associate roles with user.

https://localhost:8443/api/rest/users/{value}/associated-remote-alert-profile

GET Get associated remote-alert-profile of user.

POST Associate remote-alert-profile with user.

https://localhost:8443/api/rest/users/default

GET Get default values for user.

Resources


https://localhost:8443/api/rest/users


Methods

GET


Retrieves a list of users matching the input search filter parameters.

Note 1: The default, maximum number of users returned from the server is 1000.
Clients should use the "limit" query parameter to further control the results to the
number they can support.

Supported Maximum Search Results:
- DMA can support a maximum of 50000 user search results.

If the API client supplies a "limit" query parameter value larger than the supported
maximum search results, the server will return an HTTP response code, 400 Bad Request.

Note 2: The search criterion does not allow the use of an explicit wild-card asterisk character "*".
Instead, the system will add an implicit wild-card at the end of the search string.
Example: If the search string for username is "jo", the system will treat the search string
as "jo*" and return all users with a username that begins with "jo" such as
"jondoe", "johndoe", "joesmith", etc.

Note 3: If an asterisk is embedded in the search string such as "j*e", "jo*nd*e", etc, the system
will treat the asterisk as a literal character.
Example: The system contains two users with their first name defined as "Johnny*Doe" and "John*Doe"
respectively. The API client supplies the search string value for
for "first-name" as "John*". The system will treat the search string as "John**".
The trailing asterisk is an implicit wild-card and the preceding asterisk is a literal
character. The search result will return the user with the first name, "John*Doe".

Note 4: Wildcard search is allowed only when the query parameter "wildcard-enabled" is set to TRUE. It is
FALSE by default. When this is set to TRUE, the following behaviors are applied:

a) first-name, last-name, uuid, and domain are wildcard enabled. This means you can include a "*" anywhere in
the search string and that will stand for any number of characters. "a*min" and "a*n" and "a" and "*min" will
all find the user admin.

b) username is also wildcard enabled, but it (as it used to) searches within all of uuid, first-name, and last-name.

c) room-alias and user-role search via a "contains" method, meaning it acts just like a wildcard search where an asterisk
is added both before and after the search string, but it does not support adding wildcards to the string itself.
For example, if you search for room-id "00", it will find "1000, 1001, 001, 100, etc".

Note 5: Searching with the "domain" query parameter allows searching with partial domain name values just
like username, first-name, last-name, and user-role query parameters values are handled.

For example, assume the server is integrated with an enterprise directory that contains a set of domain
names such as the example names "CORP_DOMAIN1", "CORP_DOMAIN2", ..., "CORP_DOMAIN[N]". If the API client
provides a domain name value of "CORP_DOM", all users in all domains stated above will be returned.

However, there are some limitations. For example, if the API client specifies the exact name such as
"CORP_DOMAIN1", the search will only return users in this domain. It will not append the implicit
wild-card to search against "CORP_DOMAIN1", "CORP_DOMAIN10", "CORP_DOMAIN11", and so on.

[tags: DMA,RPRM]

Request

Query Parameters

Name Type Description
user xs:string Return only users that match the username or first name or last name.
username xs:string Return only users that match the username.
domain xs:string Return only users that are associated with network domain.
first-name xs:string Return only users with the specified first name.
last-name xs:string Return only users with the specified last name.
user-role xs:string Return only users that are associated the role such as an Administrator, Provisioner, or Auditor.
conference-room-id xs:string Return only users with the specified conference room id or alias.
custom-conference-rooms-only xs:string
Return only users that match custom conference room criterion. Custom conference room can have following values:
'true': Return users with the custom conference rooms only.
'false': Return users with or without custom conference rooms. This is also the default value.
To specify default value, this parameter can be left blank.
limit xs:int
Limit the number of users returned to this number, even if more results match the query.
Note 1: The valid integer range is 1 to 500; values between 501 and 2147483647 will result in the default limit of 500 being used.
Note 2: If the limit value is less than or equal to 0, the default of 500 will be used.
Note 3: If the limit value is greater than 2147483647, the system will respond with "404 Not Found".
This is a framework response that is due to a numeric value that exceeds a integer type.
page xs:int
When limiting the results, this specifies which page/subset of data to view.
Note 1: The valid integer range is 1 to 2147483647.
Note 2: If the page value is less than or equal to 0, the default of 1 will be used.
Note 3: If the page value is greater than 2147483647, the system will respond with "404 Not Found".
This is a framework response that is due to a numeric value that exceeds a integer type.

Response

Status Representation Description
200 application/vnd.plcm.plcm-user-list+xml
application/vnd.plcm.plcm-user-list+json
application/vnd.plcm.plcm-user-list-v2+xml
application/vnd.plcm.plcm-user-list-v2+json
application/vnd.plcm.plcm-user-list-v3+xml
application/vnd.plcm.plcm-user-list-v3+json
application/vnd.plcm.plcm-user-list-v4+xml
application/vnd.plcm.plcm-user-list-v4+json
User information successfully retrieved.
Applied to RPRM, plcm-user-list is implemented and according mediaType can be accessed by setting Http Accept.
304
User information has not changed since the last search.

Note: The API client must provide the "plcm-user-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-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 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User name and domain are required.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator, provisioner.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Current user does not have permission to request information.
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.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User does not exist in domain
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Failed to get users. Please check the Active Directory configuration or the connection between the RealPresence Resource manager and Active Directory server.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Failed to get users.

POST


Creates a local user account. Enterprise user accounts may not be created with this method. They must be imported from an enterprise directory.
UUID is optional. If not specified, one will be assigned.
Domain is optional. If specified, it must be set to LOCAL.
[tags: DMA,RPRM]

Request

Representations

application/vnd.plcm.plcm-user+xml
application/vnd.plcm.plcm-user+json
application/vnd.plcm.plcm-user-v2+xml
application/vnd.plcm.plcm-user-v2+json
application/vnd.plcm.plcm-user-v3+xml
application/vnd.plcm.plcm-user-v3+json
application/vnd.plcm.plcm-user-v4+xml
application/vnd.plcm.plcm-user-v4+json

Response

Status Representation Description
201 User created successfully.
400 text/plain
Bad request.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator, provisioner. DMA provisioners may only create users without roles.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Provisioners can only create conference users (users with no roles).
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Modification of the enterprise directory is not supported.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Modification of the enterprise directory passcodes is not supported.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Do not support lock a user.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User can only have one remote alert profile.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The user already exists.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Password complexity requirements not met.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User cannot have more than one role in maximum security mode.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Username is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
First-name is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Last-name is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Password is required (and must meet security restrictions of the system).
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Territory cannot be found.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Territory does not support conference room hosting.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default is not specified but corresponding field is specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default field is false but the corresponding field is specified with a value other than the default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default field is true but the corresponding field is not specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
ChairpersonCodes and ConferenceCodes must not exceed 16 characters

https://localhost:8443/api/rest/users/{domain}/{username}


Template Parameters

Name Type Description
domain xs:string domain arg doc
username xs:string username arg doc

Methods

GET


Retrieves information about a user account.
[tags: DMA,RPRM]

Response

Status Representation Description
200 application/vnd.plcm.plcm-user+xml
application/vnd.plcm.plcm-user+json
application/vnd.plcm.plcm-user-v2+xml
application/vnd.plcm.plcm-user-v2+json
application/vnd.plcm.plcm-user-v3+xml
application/vnd.plcm.plcm-user-v3+json
application/vnd.plcm.plcm-user-v4+xml
application/vnd.plcm.plcm-user-v4+json
User information successfully retrieved.
Applied to RPRM, plcm-user is implemented and according mediaType can be accessed by setting Http Accept.
304
User information has not changed since the last retrieval.
Note: The API client must provide the "plcm-user" 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 retrieval in the "If-None-Match" header, then
the HTTP response will contain the user representation in the message
body.

The "plcm-user" ETag can be accessed from the initial retrieval result's HTTP
response header. Also, subsequent retrievals require the identical domain and
user name 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. User 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
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Username and domain are required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Failed to get users. Please check the Active Directory configuration or the connection between the RealPresence Resource manager and Active Directory server.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Failed to get users.

DELETE


Deletes information about a local user account.
Applied to RPRM, delete an AD user, only delete related records in RPRM, not to delete actual AD user.
[tags: DMA,RPRM]

Response

Status Representation Description
204 User information successfully deleted
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User 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.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User does not exist in domain.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User does not exist in domain.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
There must always be at least one user in the local domain with administrator privileges.

PUT


Updates information about a user account. Note: The user's password will remain unchanged unless the password field is explicitly set.

Applied to RPRM, the Representations of application/vnd.plcm.plcm-user+xml and application/vnd.plcm.plcm-user+json are implemented and can be accessed by setting Http Accept.
Note: The password can be updated through this API in RPRM.

[tags: DMA,RPRM]

Request

Representations

application/vnd.plcm.plcm-user+xml
application/vnd.plcm.plcm-user+json
application/vnd.plcm.plcm-user-v2+xml
application/vnd.plcm.plcm-user-v2+json
application/vnd.plcm.plcm-user-v3+xml
application/vnd.plcm.plcm-user-v3+json
application/vnd.plcm.plcm-user-v4+xml
application/vnd.plcm.plcm-user-v4+json

Response

Status Representation Description
204
User information successfully updated.
Note: The response will only contain both an ETag value
and link to the updated user resource.
400 text/plain
Bad request.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator, provisioner
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such user.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
You do not have the appropriate user role to make this configuration change.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Administrators cannot disable themselves.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Cannot remove role Administrator derived from the enterprise group membership.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Cannot remove role Provisioner derived from the enterprise group membership.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Cannot remove role Auditor derived from the enterprise group membership.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Do not support lock a user.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User can only have one remote alert profile.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The DMA does not support the user "tenant" attribute.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The DMA does not support the user "title" attribute.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The DMA does not support the user "phone-number" attribute.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The DMA does not support the user "city" attribute.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The DMA does not support the user "department" attribute.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The user resource has changed on the server.

Note: The response will contain the ETag value and link that reflects
the server's user 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.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
Username or domain in object does not match the URI.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User cannot have more than one role in maximum security mode.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Not connected to enterprise directory.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
There must always be at least one user in the local domain with administrator privileges.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
First-name is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Last-name is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Territory cannot be found.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Territory does not support conference room hosting.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default is not specified but corresponding field is specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default field is false but the corresponding field is specified with a value other than the default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default field is true but the corresponding field is not specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
ChairpersonCodes and ConferenceCodes must not exceed 16 characters
428 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

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.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/users/self


Methods

GET


Retrieves information about logged in user account.
[tags: DMA,RPRM]

Response

Status Representation Description
200 application/vnd.plcm.plcm-user+xml
application/vnd.plcm.plcm-user+json
application/vnd.plcm.plcm-user-v2+xml
application/vnd.plcm.plcm-user-v2+json
application/vnd.plcm.plcm-user-v3+xml
application/vnd.plcm.plcm-user-v3+json
application/vnd.plcm.plcm-user-v4+xml
application/vnd.plcm.plcm-user-v4+json

User information successfully retrieved.
304
User information has not changed since the last retrieval.
Note: The API client must provide the "plcm-user" 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 retrieval in the "If-None-Match" header, then
the HTTP response will contain the user representation in the message
body.

The "plcm-user" ETag can be accessed from the initial retrieval result's HTTP
response header. Also, subsequent retrievals require the identical domain and
user name to ensure an equivalent ETag value. This also assumes no other client made changes to
users on the server.

https://localhost:8443/api/rest/users/self/password


Methods

POST

Changes password of the currently logged in user. [tags: DMA]

Request

Representations

application/vnd.plcm.plcm-change-password-request+xml
application/vnd.plcm.plcm-change-password-request+json

Response

Status Representation Description
204 User password was successfully updated.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The old-password is required.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The new-password is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Old password is not valid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
New password was used before.

https://localhost:8443/api/rest/users/self/logout


Methods

DELETE

Logs out the current user [tags: DMA]

Request

Response

Status Representation Description
204 User session logged out

https://localhost:8443/api/rest/users/self/login-history


Methods

GET

Retrieves the login history of the calling user. [tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-user-login-history+xml
application/vnd.plcm.plcm-user-login-history+json
User's login history successfully retrieved.
304
User login statistics has not changed since the last retrieval.
Note: The API client must provide the "plcm-user-login-history" 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 retrieval in the "If-None-Match" header, then
the HTTP response will contain the user representation in the message
body.

The "plcm-user-login-history" ETag can be accessed from the initial retrieval result's HTTP
response header.

https://localhost:8443/api/rest/users/user-uuids


Methods

GET


Retrieves a list of user uuids in db.
[tags: RPRM_INTERNAL]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-string-list+xml
application/vnd.plcm.plcm-string-list+json
User uuid information successfully retrieved. Return user uuid list, its type is string list.
304
User information has not changed since the last search.

Note: The API client must provide the "plcm-string-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-string-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.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission. User roles required: administrator, provisioner.
403 application/vnd.plcm.plcm-error+xml
Current user does not have permission to request information.
403 application/vnd.plcm.plcm-error+xml
Users in the LOCAL domain are not allowed access to information in the enterprise directory.
404 application/vnd.plcm.plcm-error+xml
No such user.

https://localhost:8443/api/rest/users/authentication


Methods

POST

Authenticate the user.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-user-authenticate-password+xml
application/vnd.plcm.plcm-user-authenticate-password+json

Response

Status Representation Description
200 application/vnd.plcm.plcm-boolean+xml
application/vnd.plcm.plcm-boolean+json
Get authentication successfully.
If passed the authentication, true will be returned, else false.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User does not exist in domain.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Domain does not exist.

https://localhost:8443/api/rest/users/{value}


Template Parameters

Name Type Description
value xs:string user-uuid arg.

Methods

GET


Retrieves information about a user account.
[tags: RPRM_INTERNAL]

Response

Status Representation Description
200 application/vnd.plcm.plcm-user+xml
application/vnd.plcm.plcm-user+json
User information successfully retrieved.
304
User information has not changed since the last retrieval.
Note: The API client must provide the "plcm-user" 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 retrieval in the "If-None-Match" header, then
the HTTP response will contain the user representation in the message
body.

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

PUT


Updates information about a user account.
This api doesn't support entity-tag validation.
[tags: RPRM]

Request

Representations

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

Response

Status Representation Description
204 Update user success.
400 text/plain
Bad request.
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
You do not have the appropriate user role to make this configuration change.
403 application/vnd.plcm.plcm-error+xml
Administrators cannot disable themselves.
403 application/vnd.plcm.plcm-error+xml
Cannot remove role Administrator derived from the enterprise group membership.
403 application/vnd.plcm.plcm-error+xml
Cannot remove role Provisioner derived from the enterprise group membership.
403 application/vnd.plcm.plcm-error+xml
Cannot remove role Auditor derived from the enterprise group membership.
409 application/vnd.plcm.plcm-error+xml
Lock user operation is not supported.
409 application/vnd.plcm.plcm-error+xml
Username or domain in object does not match the parameters.
409 application/vnd.plcm.plcm-error+xml
Not connected to enterprise directory.
409 application/vnd.plcm.plcm-error+xml
There must always be at least one user in the local domain with administrator privileges.
409 application/vnd.plcm.plcm-error+xml
Valid username is required.
409 application/vnd.plcm.plcm-error+xml
First-name is required.
409 application/vnd.plcm.plcm-error+xml
Valid first Name is required
409 application/vnd.plcm.plcm-error+xml
Last-name is required.
409 application/vnd.plcm.plcm-error+xml
Valid last Name is required.
409 application/vnd.plcm.plcm-error+xml
Password is required.
409 application/vnd.plcm.plcm-error+xml
Passwords cannot have leading or trailing spaces.
409 application/vnd.plcm.plcm-error+xml
Email Address is required.
409 application/vnd.plcm.plcm-error+xml
The following user roles are invalid
409 application/vnd.plcm.plcm-error+xml
User phone number conflicts.

https://localhost:8443/api/rest/users/{value}/associated-devices


Template Parameters

Name Type Description
value xs:string user-uuid arg.

Methods

GET

Get associated deviceIds of user.
[tags: RPRM]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-string-list+xml
application/vnd.plcm.plcm-string-list+json
Get Associated deviceIds of user 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 devices to user with device id list.
[tags: RPRM]

Request

Representations

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

Response

Status Representation Description
204 Associate devices with user successfully.
400 application/vnd.plcm.plcm-error+xml
UUID is invalid
400 application/vnd.plcm.plcm-error+xml
The user-uuid is required.
400 application/vnd.plcm.plcm-error+xml
The device can not be associated because it is not an assignable device.
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
400 application/vnd.plcm.plcm-error+xml
The input param is required
409 application/vnd.plcm.plcm-error+xml
Area feature is not enabled in system settings, so link of area is not permitted.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.
409 application/vnd.plcm.plcm-error+xml
Device ID is invalid.

https://localhost:8443/api/rest/users/{value}/associated-roles


Template Parameters

Name Type Description
value xs:string user-uuid arg.

Methods

GET

Get associated role-uuids of user.
[tags: RPRM]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-string-list+xml
application/vnd.plcm.plcm-string-list+json
Get Associated role-uuids of user 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 user.
[tags: RPRM]

Request

Representations

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

Response

Status Representation Description
204 Associate roles with user 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
400 application/vnd.plcm.plcm-error+xml
The input param is required
404 application/vnd.plcm.plcm-error+xml
User role can not be found by UUID
409 application/vnd.plcm.plcm-error+xml
Cannot remove local admin user role of Administrator.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.

https://localhost:8443/api/rest/users/{value}/associated-remote-alert-profile


Template Parameters

Name Type Description
value xs:string user-uuid arg.

Methods

GET

Get associated remote-alert-profile of user.
[tags: RPRM]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-string+xml
application/vnd.plcm.plcm-string+json
Get Associated remote-alert-profile of user successfully. If no remote-alert-profile associated, then return 0.
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 remote-alert-profile with user.
[tags: RPRM]

Request

Query Parameters

Name Type Description
remote-alert-profile-identifier xs:string remote-alert-profile id arg doc

Response

Status Representation Description
204 Associate remote-alert-profile with user 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
409 application/vnd.plcm.plcm-error+xml
The remote-alert-profile-id is required.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.

https://localhost:8443/api/rest/users/default


Methods

GET

Get default values for user.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-user-defaults+xml
application/vnd.plcm.plcm-user-defaults+json
Successfully
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission.