| GET | /api/services/single/users | ||
|---|---|---|---|
| GET | /api/services/{ServiceGuid}/users | Get users for a service. | ServiceUserGroupGuid / ServiceUserGroupType - Identify the group the service user will be added to: if only ServiceUserGroupGuid is specified then the group identified by that guid is used; if only ServiceUserGroupType is specified then the default group for that type is used; if both ServiceUserGroupGuid and ServiceUserGroupType are specified, the type of the group identified by the ServiceUserGroupGuid has to match the ServiceUserGroupType; if neither ServiceUserGroupGuid nor ServiceUserGroupType are specified, the user will be assigned the services' default package for users. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServiceGuid | query | Guid | No | Must provide ServiceGuid if ServiceCode is null. |
| ServiceCode | query | String | No | Must provide ServiceCode if ServiceGuid is null. |
| ServiceUserGroupGuid | query | Guid | No | |
| ServiceUserGroupType | query | String | No | Allowable Values
|
| Token | query | String | No | |
| Page | query | Integer | No | |
| PageSize | query | Integer | 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 | ServiceUser[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServiceUserGuid | body | Guid | No | |
| EmailAddress | form | string | No | |
| CreatedOn | body | DateTime | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| Status | form | string | No | Allowable Values
|
| RegisteredOn | body | DateTime | No | |
| PackageExpiry | body | DateTime | No | |
| Language | form | string | No | Allowable Values
|
| EmailAliases | form | Dictionary<string, string> | No | |
| GroupName | form | string | No | |
| GroupGuid | body | Guid | No | |
| GroupType | form | string | No | Allowable Values
|
| EnableCampaigns | form | bool | No | Allowable Values
|
| EnableESignatures | form | bool | No | Allowable Values
|
| LastLogin | body | DateTime | No | |
| LastIpAddress | form | string | No | |
| CurrentToolbarVersion | form | string | No | |
| PasswordExpiry | form | DateTime? | No | |
| PasswordThrottled | form | bool | No | |
| DefaultSecure | form | string | No | Allowable Values
|
| BlacklistMode | form | string | No | Allowable Values
|
| EnableMfa | form | bool | No | Allowable Values
|
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/services/single/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": [
{
"serviceUserGuid": "00000000000000000000000000000000",
"emailAddress": "String",
"createdOn": "0001-01-01T00:00:00Z",
"firstName": "String",
"lastName": "String",
"status": "String",
"registeredOn": "0001-01-01T00:00:00Z",
"packageExpiry": "0001-01-01T00:00:00Z",
"language": "String",
"emailAliases": {
"String": "String"
},
"groupName": "String",
"groupGuid": "00000000000000000000000000000000",
"groupType": "String",
"enableCampaigns": false,
"enableESignatures": false,
"lastLogin": "0001-01-01T00:00:00Z",
"lastIpAddress": "String",
"currentToolbarVersion": "String",
"passwordExpiry": "0001-01-01T00:00:00Z",
"passwordThrottled": false,
"defaultSecure": "String",
"blacklistMode": "String",
"enableMfa": false
}
],
"responseStatus": {
"errorCode": "String",
"message": "String",
"stackTrace": "String",
"errors": [
{
"errorCode": "String",
"fieldName": "String",
"message": "String",
"meta": {
"String": "String"
}
}
],
"meta": {
"String": "String"
}
}
}