GET | /users/all |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrganisationId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Distinct | form | string | No | |
Limit | form | int? | No | |
Offset | form | int? | No | |
Sort | form | string | No | |
Filter | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Embed | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
UserDetails | form | List<UserDetails> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LastLoginDate | form | DateTime? | No | |
TwoFactorEnabled | form | bool | No | |
Name | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserId | form | string | No | |
UserEmailAddress | form | string | No | |
Status | form | AccountStatus | No | |
Type | form | AccountType | No | |
Roles | form | List<string> | No | |
Id | form | string | No | |
OrganisationId | form | string | No |
Shadowed | |
Registered |
Person | |
Machine |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
UserDetails | form | List<UserDetails> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /users/all HTTP/1.1 Host: foundrystage-api-app.azurewebsites.net Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"userDetails":[{"lastLoginDate":null,"twoFactorEnabled":false,"name":"String","userId":"String","userEmailAddress":"String","status":"Shadowed","type":"Person","roles":["String"],"id":"String","organisationId":"String"}]}