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.
|
GETRetrieves 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] RequestQuery Parameters
Response
POSTCreates 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] RequestRepresentationsResponse |
Name | Type | Description |
---|---|---|
domain | xs:string | domain arg doc |
username | xs:string | username arg doc |
GETRetrieves information about a user account. [tags: DMA,RPRM] Response
DELETEDeletes 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
PUTUpdates 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] RequestRepresentationsResponse
|
GETRetrieves information about logged in user account. [tags: DMA,RPRM] Response
|
POSTChanges password of the currently logged in user. [tags: DMA]RequestRepresentations
Response
|
DELETELogs out the current user [tags: DMA]RequestResponse
|
GETRetrieves the login history of the calling user. [tags: DMA]Response
|
GETRetrieves a list of user uuids in db. [tags: RPRM_INTERNAL] RequestResponse
|
POSTAuthenticate the user.[tags: RPRM] RequestRepresentations
Response
|
Name | Type | Description |
---|---|---|
value | xs:string | user-uuid arg. |
GETRetrieves information about a user account. [tags: RPRM_INTERNAL] Response
PUTUpdates information about a user account. This api doesn't support entity-tag validation. [tags: RPRM] RequestRepresentations
Response
|
Name | Type | Description |
---|---|---|
value | xs:string | user-uuid arg. |
GETGet associated deviceIds of user.[tags: RPRM] RequestResponse
POSTAssociate devices to user with device id list.[tags: RPRM] RequestRepresentations
Response
|
Name | Type | Description |
---|---|---|
value | xs:string | user-uuid arg. |
GETGet associated role-uuids of user.[tags: RPRM] RequestResponse
POSTAssociate roles with user.[tags: RPRM] RequestRepresentations
Response
|
Name | Type | Description |
---|---|---|
value | xs:string | user-uuid arg. |
GETGet associated remote-alert-profile of user.[tags: RPRM] RequestResponse
POSTAssociate remote-alert-profile with user.[tags: RPRM] RequestQuery Parameters
Response
|
GETGet default values for user.[tags: DMA] Response
|