• Account Management
  • Alias
  • Application
  • Application Admin
  • Application Licensing
  • Audit
  • Backup
  • Directory
  • Directory Admin
  • Group Admin
  • Group Level Admin
  • Groups
  • Groups Membership
  • LDAP Connection Pool
  • Look and Feel
  • Mail Server
  • Remember Me
  • SAML Configuration
  • Server Info
  • Sessions
  • Token
  • User Admin
  • User Authentication
  • Users
Server
Crowd Data Center / / REST API

Users

Postman Collection
OpenAPI
GET

Get user

Retrieves user details. Either username or key query parameter must be present. The 'expand' parameter can be used to include additional data in the response. This can currently be set to 'attributes', to include the user's attributes in the response

Request

Query parameters

username

string

key

string

Responses

the representation of the found user

application/json application/xml

any

GET/rest/usermanagement/1/user
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/usermanagement/1/user' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser", "rel": "self" }, "name": "sampleuser", "password": { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser", "rel": "edit" } }, "key": "557057:927441f1-cc92-4030-b633-8a2bbdf7136e", "active": true, "attributes": { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange", "rel": "self" }, "attribute": [ { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts", "rel": "self" }, "name": "invalidPasswordAttempts", "values": [ "0" ] }, { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange", "rel": "self" }, "name": "requiresPasswordChange", "values": [ "false" ] } ] }, "first-name": "Sample", "last-name": "User", "display-name": "Sample User", "email": "sample@user.cool" }
PUT

Update user

Updates a user

Request

Query parameters

username

string

Request bodyapplication/json application/xml

user entity containing data to be updated

active

boolean

attributes

MultiValuedAttributeEntityList

createdDate

string

directoryId

integer

directoryName

string

displayName

string

email

string

encryptedPassword

PasswordEntity

expanded

boolean

firstName

string

Responses

the user was successfully updated

application/json application/xml

any

PUT/rest/usermanagement/1/user
1 2 3 4 5 curl --request PUT \ --url 'http://{baseurl}/rest/rest/usermanagement/1/user' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '"{\n \"name\" : \"sampleuser\",\n \"firstName\" : \"Sample\",\n \"lastName\" : \"User\",\n \"displayName\" : \"Sample User\",\n \"active\" : true,\n \"attributes\" : null,\n \"email\" : \"sample@user.cool\",\n}\n"'
204Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser", "rel": "self" }, "name": "sampleuser", "password": { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser", "rel": "edit" } }, "key": "557057:927441f1-cc92-4030-b633-8a2bbdf7136e", "active": true, "attributes": { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange", "rel": "self" }, "attribute": [ { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts", "rel": "self" }, "name": "invalidPasswordAttempts", "values": [ "0" ] }, { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange", "rel": "self" }, "name": "requiresPasswordChange", "values": [ "false" ] } ] }, "first-name": "Sample", "last-name": "User", "display-name": "Sample User", "email": "sample@user.cool" }
POST

Add user

Creates a new user

Request

Request bodyapplication/json application/xml

user entity to be created

active

boolean

attributes

MultiValuedAttributeEntityList

createdDate

string

directoryId

integer

directoryName

string

displayName

string

email

string

encryptedPassword

PasswordEntity

expanded

boolean

firstName

string

Responses

the user was successfully created

application/json application/xml

any

POST/rest/usermanagement/1/user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 curl --request POST \ --url 'http://{baseurl}/rest/rest/usermanagement/1/user' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "link": null, "name": "sampleuser", "firstName": "Sample", "lastName": "User", "displayName": "Sample User", "directoryId": null, "password": { "link": null, "value": "secret" }, "encryptedPassword": null, "key": null, "createdDate": null, "updatedDate": null, "directoryName": null, "active": true, "attributes": null, "email": "sample@user.cool", "expanded": true }'
201Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser", "rel": "self" }, "name": "sampleuser", "password": { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser", "rel": "edit" } }, "key": "557057:927441f1-cc92-4030-b633-8a2bbdf7136e", "active": true, "attributes": { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange", "rel": "self" }, "attribute": [ { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts", "rel": "self" }, "name": "invalidPasswordAttempts", "values": [ "0" ] }, { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange", "rel": "self" }, "name": "requiresPasswordChange", "values": [ "false" ] } ] }, "first-name": "Sample", "last-name": "User", "display-name": "Sample User", "email": "sample@user.cool" }
DEL

Remove user

Removes a user

Request

Query parameters

username

string

Responses

the user was successfully removed

DEL/rest/usermanagement/1/user
1 2 curl --request DELETE \ --url 'http://{baseurl}/rest/rest/usermanagement/1/user'
GET

Get user attributes

Retrieves a list of user attributes

Request

Query parameters

username

string

Responses

user attributes were successfully renamed

application/json application/xml

any

GET/rest/usermanagement/1/user/attribute
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/usermanagement/1/user/attribute' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange", "rel": "self" }, "attribute": [ { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts", "rel": "self" }, "name": "invalidPasswordAttempts", "values": [ "0" ] }, { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange", "rel": "self" }, "name": "requiresPasswordChange", "values": [ "false" ] } ] }
POST

Add user attributes

Stores the user attributes. Attribute values will not be overwritten if not specified in attributes

Request

Query parameters

username

string

Request bodyapplication/json application/xml

authentication information

attributes

array<MultiValuedAttributeEntity>

callback

ListWrapperCallbackMultiValuedAttributeEntity

empty

boolean

link

Link

Responses

the attributes were successfully updated

POST/rest/usermanagement/1/user/attribute
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 curl --request POST \ --url 'http://{baseurl}/rest/rest/usermanagement/1/user/attribute' \ --header 'Content-Type: application/json' \ --data '{ "attribute": [ { "name": "invalidPasswordAttempts", "values": [ "0" ] }, { "name": "requiresPasswordChange", "values": [ "false" ] } ] }'
DEL

Delete user attribute

Deletes a user attribute

Request

Query parameters

username

string

Required
attributename

string

Required

Responses

the attributes was successfully deleted, or the attribute was not defined for the user

DEL/rest/usermanagement/1/user/attribute
1 2 curl --request DELETE \ --url 'http://{baseurl}/rest/rest/usermanagement/1/user/attribute?username={username}&attributename={attributename}'
GET

Get user avatar

Returns the url of the user's avatar

Request

Query parameters

username

string

Required
s

integer

Responses

the uri for the user's avatar (in the location header)

GET/rest/usermanagement/1/user/avatar
1 2 curl --request GET \ --url 'http://{baseurl}/rest/rest/usermanagement/1/user/avatar?username={username}'
POST

Expire all passwords

Expires all passwords for all directories which are part of this application, regardless of group mapping

Request

Query parameters

confirm

boolean

Required

Responses

passwords were expired successfully

POST/rest/usermanagement/1/user/expire-all-passwords
1 2 curl --request POST \ --url 'http://{baseurl}/rest/rest/usermanagement/1/user/expire-all-passwords?confirm={confirm}'
GET

Get direct groups

Returns the a list of groups the user is a direct member of

Request

Query parameters

username

string

Required
groupname

string

max-results

integer

start-index

integer

Responses

a list of groups was retrieved successfully

application/json application/xml

any

GET/rest/usermanagement/1/user/group/direct
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/usermanagement/1/user/group/direct?username={username}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 { "group": [ { "link": { "href": "https://crowdserver/crowd/group?groupname=group&groupname=crowd-administrators", "rel": "self" }, "name": "crowd-administrators" } ] }
POST

Add user to group

Adds a user as a direct member of the group

Request

Query parameters

username

string

Required

Request bodyapplication/json application/xml

parent group entity

active

boolean

attributes

MultiValuedAttributeEntityList

description

string

expanded

boolean

link

Link

name

string

type

string

Responses

the user was successfully added to the group

POST/rest/usermanagement/1/user/group/direct
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 curl --request POST \ --url 'http://{baseurl}/rest/rest/usermanagement/1/user/group/direct?username={username}' \ --header 'Content-Type: application/json' \ --data '{ "active": true, "attributes": { "attributes": [ { "link": {}, "name": "<string>", "value": "<string>", "values": [ "<string>" ] } ], "callback": {}, "empty": true, "link": { "href": "<string>", "rel": "<string>" } }, "description": "<string>", "expanded": true, "link": { "href": "<string>", "rel": "<string>" }, "name": "<string>", "type": "GROUP" }'
DEL

Remove user from group

Removes a user from a group

Request

Query parameters

username

string

Required
groupname

string

Required

Responses

the user was successfully removed from the group

DEL/rest/usermanagement/1/user/group/direct
1 2 curl --request DELETE \ --url 'http://{baseurl}/rest/rest/usermanagement/1/user/group/direct?username={username}&groupname={groupname}'
GET

Get nested group

Retrieves the group that the user is a nested member of

Request

Query parameters

username

string

Required
groupname

string

max-results

integer

start-index

integer

Responses

the user was successfully removed from the group

application/json application/xml

any

GET/rest/usermanagement/1/user/group/nested
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/usermanagement/1/user/group/nested?username={username}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 { "group": [ { "link": { "href": "https://crowdserver/crowd/group?groupname=group&groupname=crowd-administrators", "rel": "self" }, "name": "crowd-administrators" } ] }
POST

Request password reset

Sends the user a password reset link to the user's email address

Request

Query parameters

username

string

Required

Responses

the password was reset link was sent

POST/rest/usermanagement/1/user/mail/password
1 2 curl --request POST \ --url 'http://{baseurl}/rest/rest/usermanagement/1/user/mail/password?username={username}'
POST

Request usernames reminder

Requests an email to be sent containing usernames associated with the given email address

Request

Query parameters

email

string

Required

Responses

email was sent successfully

POST/rest/usermanagement/1/user/mail/usernames
1 2 curl --request POST \ --url 'http://{baseurl}/rest/rest/usermanagement/1/user/mail/usernames?email={email}'
PUT

Update user password

Updates a user password

Request

Query parameters

username

string

Required

Request bodyapplication/json application/xml

update password entity

link

Link

value

string

Responses

the password was updated

PUT/rest/usermanagement/1/user/password
1 2 3 4 5 6 7 curl --request PUT \ --url 'http://{baseurl}/rest/rest/usermanagement/1/user/password?username={username}' \ --header 'Content-Type: application/json' \ --data '{ "link": null, "value": "hunter2" }'
DEL

Delete user password

Deletes a user password. This will prevent the user from logging in using a password

Request

Query parameters

username

string

Required

Responses

the password was deleted

DEL/rest/usermanagement/1/user/password
1 2 curl --request DELETE \ --url 'http://{baseurl}/rest/rest/usermanagement/1/user/password?username={username}'
POST

Rename user

Renames a user

Request

Query parameters

username

string

Request bodyapplication/json application/xml

rename user entity

newName

string

Responses

the user was successfully renamed

application/json application/xml

any

POST/rest/usermanagement/1/user/rename
1 2 3 4 5 6 7 curl --request POST \ --url 'http://{baseurl}/rest/rest/usermanagement/1/user/rename' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "newName": "sampleuser-brandnewname" }'
204Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser", "rel": "self" }, "name": "sampleuser", "password": { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser", "rel": "edit" } }, "key": "557057:927441f1-cc92-4030-b633-8a2bbdf7136e", "active": true, "attributes": { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange", "rel": "self" }, "attribute": [ { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts", "rel": "self" }, "name": "invalidPasswordAttempts", "values": [ "0" ] }, { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange", "rel": "self" }, "name": "requiresPasswordChange", "values": [ "false" ] } ] }, "first-name": "Sample", "last-name": "User", "display-name": "Sample User", "email": "sample@user.cool" }

Rate this page: