External DocumentationTo learn more, visit the Atlassian Crowd documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Active | Set whether the entity is active. |
| Directory ID | The ID of the directory the entity belongs to. |
| Directory Name | The name of the directory the entity belongs to. |
| Display Name | The user’s display name. |
| The user’s email address. | |
| Expand | Set if the response should include expanded information. |
| First Name | The user’s first name. |
| Key | The user’s unique key. |
| Last Name | The user’s last name. |
| Password | The user’s password. |
| Username | The username of the user. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Attributes | Additional attributes of the entity. For example: For more information about the Attributes parameter, visit Atlassian Crowd API documentation. |
| Encrypted Password | The user’s encrypted password. |
| Link Href | The URL that points to the related entity. |
| Link Rel | The relationship type of the linked entity (e.g., self, next, previous). |
Example Output
{
"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"
}