GET | /api/partners/{PartnerGuid}/users | Gets a paged list of Partners AdminUsers. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PartnerGuid | path | Guid | Yes | The Partner you want to get AdminUsers for. |
Page | query | String | No | The Page number being requested. Defaults to 1. |
PageSize | query | String | No | The Page Size returned by the operation. Defaults to 25. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PageSize | body | Integer | No | |
TotalPages | body | Integer | No | |
TotalItems | body | Integer | No | |
CurrentPage | body | Integer | No | |
Results | body | AdminUser[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserGuid | body | Guid | No | |
EmailAddress | form | string | No | |
UserTypeGuid | body | Guid | No | |
CreatedOn | body | DateTime | No | |
UserType | form | AdminUserEnum | No | Allowable Values
|
Status | form | AdminUserStatusEnum | No | Allowable Values
|
Permissions | form | List<string> | No | |
Roles | form | List<string> | 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 /api/partners/{PartnerGuid}/users HTTP/1.1 Host: api.secure-messaging.com Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length { "pageSize": 0, "totalPages": 0, "totalItems": 0, "currentPage": 0, "results": [ { "userGuid": "00000000000000000000000000000000", "emailAddress": "String", "userTypeGuid": "00000000000000000000000000000000", "createdOn": "0001-01-01T00:00:00Z", "userType": "SuperUser", "status": "Active", "permissions": [ "String" ], "roles": [ "String" ] } ], "responseStatus": { "errorCode": "String", "message": "String", "stackTrace": "String", "errors": [ { "errorCode": "String", "fieldName": "String", "message": "String", "meta": { "String": "String" } } ], "meta": { "String": "String" } } }