Requires the role: | manager |
POST | /users/{Id}/roles/assign |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | string | No | |
Roles | body | List<string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
UserAccount | form | UserAccount | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | UserAccountName | No | |
DisplayName | form | string | No | |
form | string | No | ||
Roles | form | List<string> | No | |
Status | form | AccountStatus | No | |
DefaultOrganisationId | form | string | No | |
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FirstName | form | string | No | |
LastName | form | string | No |
Shadowed | |
Registered |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
UserAccount | form | UserAccount | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /users/{Id}/roles/assign HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"id":"String","roles":["String"]}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"userAccount":{"name":{"firstName":"String","lastName":"String"},"displayName":"String","email":"String","roles":["String"],"status":"Shadowed","defaultOrganisationId":"String","id":"String"}}