Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
Top
Top

...

Info
titleBase URL for User REST API

http://host:port/flexdeploy/rest/v1/administration/security/user

...

Info
titleAPI URL

http://host:port/flexdeploy/rest/v1/administration/security/user/{Id}

...

http://host:port/flexdeploy/rest/v1/administration/security/user/10000

...

GET (Using Query Parameters)

This GET service will return a list of users in the form of JSON objects based on the query parameters user name, first name, last name and group id. Users are only returned if they match all of the specified query parameters. If no query parameters are given this request will return the entire list of users.

Info
titleAPI URLs

http://host:port/flexdeploy/rest/v1/administration/security/user?

Append the following character sequences to the above URL to specify Query parameters.
Use '&' between successive query parameters: 

userName={userName}

firstName={firstName} *

lastName={lastName} *

groupId={groupId}

Examples:
To search by user name only:

http://host:port/flexdeploy/rest/topology/administration/security/user?userName=fdadmin

To search by first name and last name:

http://host:port/flexdeploy/rest/topology/administration/security/user?firstName=John&lastName=Smith

To search by group id

http://host:port/flexdeploy/rest/topology/administration/security/user?groupId=11101

...

http://host:port/flexdeploy/rest/v1/administration/security/user?groupId=10010

...

Info
titleAPI URL

http://host:port/flexdeploy/rest/v1/administration/security/user

...

Back to Top

...

PATCH

This PATCH service will update an existing user with the information passed through a JSON object. If an attribute of the JSON is null it will not be updated in the user. Groups that are included in a PATCH will be added, but existing groups will still remain.

Info
titleAPI URL

http://host:port/flexdeploy/administration/security/user/{Id}

...