PUT v1/bunits/{bunitId}/orainusers/{oRainUserId}
Update a user.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
bunitId |
The ID of the business unit of the user | integer |
Required |
oRainUserId |
The ID of the user to update | integer |
Required |
Body Parameters
The user to update
ORainUser| Name | Description | Type | Additional information |
|---|---|---|---|
Name |
string |
None. |
|
UserName |
string |
None. |
|
ORainId |
string |
None. |
|
Locked |
When a user is locked thay are not able to log on to the oRain interface Using an S3 browser to connect to the bucket with the user is not affected by this setting. 0 = not locked 9 = locked |
integer |
None. |
Phone |
string |
None. |
|
Email |
string |
None. |
|
AvailableForDescendants |
boolean |
None. |
|
Inherited |
boolean |
None. |
|
AutoAssignBuckets |
boolean |
None. |
|
Server |
ORainServer |
None. |
|
BusinessUnit |
BusinessUnit |
None. |
|
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
Response Information
Resource Description
The updated user
ORainUser| Name | Description | Type | Additional information |
|---|---|---|---|
Name |
string |
None. |
|
UserName |
string |
None. |
|
ORainId |
string |
None. |
|
Locked |
When a user is locked thay are not able to log on to the oRain interface Using an S3 browser to connect to the bucket with the user is not affected by this setting. 0 = not locked 9 = locked |
integer |
None. |
Phone |
string |
None. |
|
Email |
string |
None. |
|
AvailableForDescendants |
boolean |
None. |
|
Inherited |
boolean |
None. |
|
AutoAssignBuckets |
boolean |
None. |
|
Server |
ORainServer |
None. |
|
BusinessUnit |
BusinessUnit |
None. |
|
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.