GET api/v7/Users
Gets all users for a tenant
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Returns a list of all users for a tenant
Collection of Complete User Information| Name | Description | Type |
|---|---|---|
| roles |
Roles of the user |
Collection of Role Information |
| active |
Flag denoting if user is active |
boolean |
| startDate |
Start Date of User Activity |
date |
| endDate |
End date of user activity |
date |
| contactInfo |
Contact Information of the User |
Contact Information |
| addressInfo |
Address Information of the User |
Address Information |
| userId |
User Id |
string |
| firstName |
First Name of the User |
string |
| lastName |
Last Name of the User |
string |
| displayName |
Preferred Display Name |
string |
| alternateId |
Alternate user Id |
string |
| primaryLanguage |
Primary Language of User |
string |
| secondaryLanguage |
Secondary Language of the User |
string |
| customerAuditDate |
Last modified audit information |
date |
Response Formats
application/json, text/json
Sample:
[
{
"roles": [
{
"orgName": "sample string 1",
"roleName": "sample string 2",
"roleCode": "sample string 3"
},
{
"orgName": "sample string 1",
"roleName": "sample string 2",
"roleCode": "sample string 3"
}
],
"active": true,
"startDate": "2018-01-01T00:00:00",
"endDate": "2018-01-01T00:00:00",
"contactInfo": {
"homePhone": "sample string 1",
"workPhone": "sample string 2",
"cellPhone": "sample string 3",
"email": "sample string 4"
},
"addressInfo": {
"addressLine1": "sample string 1",
"addressLine2": "sample string 2",
"addressLine3": "sample string 3",
"city": "sample string 4",
"administrativeArea": "sample string 5",
"postalCode": "sample string 6",
"country": "sample string 7"
},
"userId": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"displayName": "sample string 5",
"alternateId": "sample string 6",
"primaryLanguage": "sample string 7",
"secondaryLanguage": "sample string 8",
"customerAuditDate": "2018-01-01T00:00:00"
},
{
"roles": [
{
"orgName": "sample string 1",
"roleName": "sample string 2",
"roleCode": "sample string 3"
},
{
"orgName": "sample string 1",
"roleName": "sample string 2",
"roleCode": "sample string 3"
}
],
"active": true,
"startDate": "2018-01-01T00:00:00",
"endDate": "2018-01-01T00:00:00",
"contactInfo": {
"homePhone": "sample string 1",
"workPhone": "sample string 2",
"cellPhone": "sample string 3",
"email": "sample string 4"
},
"addressInfo": {
"addressLine1": "sample string 1",
"addressLine2": "sample string 2",
"addressLine3": "sample string 3",
"city": "sample string 4",
"administrativeArea": "sample string 5",
"postalCode": "sample string 6",
"country": "sample string 7"
},
"userId": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"displayName": "sample string 5",
"alternateId": "sample string 6",
"primaryLanguage": "sample string 7",
"secondaryLanguage": "sample string 8",
"customerAuditDate": "2018-01-01T00:00:00"
}
]
application/xml, text/xml
Sample:
<ArrayOfUser xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<User>
<userId>sample string 2</userId>
<firstName>sample string 3</firstName>
<lastName>sample string 4</lastName>
<displayName>sample string 5</displayName>
<alternateId>sample string 6</alternateId>
<primaryLanguage>sample string 7</primaryLanguage>
<secondaryLanguage>sample string 8</secondaryLanguage>
<customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
<active>true</active>
<startDate>2018-01-01T00:00:00</startDate>
<endDate>2018-01-01T00:00:00</endDate>
<contactInfo>
<homePhone>sample string 1</homePhone>
<workPhone>sample string 2</workPhone>
<cellPhone>sample string 3</cellPhone>
<email>sample string 4</email>
</contactInfo>
<addressInfo>
<addressLine1>sample string 1</addressLine1>
<addressLine2>sample string 2</addressLine2>
<addressLine3>sample string 3</addressLine3>
<city>sample string 4</city>
<administrativeArea>sample string 5</administrativeArea>
<postalCode>sample string 6</postalCode>
<country>sample string 7</country>
</addressInfo>
<roles>
<RoleInfo>
<orgName>sample string 1</orgName>
<roleName>sample string 2</roleName>
<roleCode>sample string 3</roleCode>
</RoleInfo>
<RoleInfo>
<orgName>sample string 1</orgName>
<roleName>sample string 2</roleName>
<roleCode>sample string 3</roleCode>
</RoleInfo>
</roles>
</User>
<User>
<userId>sample string 2</userId>
<firstName>sample string 3</firstName>
<lastName>sample string 4</lastName>
<displayName>sample string 5</displayName>
<alternateId>sample string 6</alternateId>
<primaryLanguage>sample string 7</primaryLanguage>
<secondaryLanguage>sample string 8</secondaryLanguage>
<customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
<active>true</active>
<startDate>2018-01-01T00:00:00</startDate>
<endDate>2018-01-01T00:00:00</endDate>
<contactInfo>
<homePhone>sample string 1</homePhone>
<workPhone>sample string 2</workPhone>
<cellPhone>sample string 3</cellPhone>
<email>sample string 4</email>
</contactInfo>
<addressInfo>
<addressLine1>sample string 1</addressLine1>
<addressLine2>sample string 2</addressLine2>
<addressLine3>sample string 3</addressLine3>
<city>sample string 4</city>
<administrativeArea>sample string 5</administrativeArea>
<postalCode>sample string 6</postalCode>
<country>sample string 7</country>
</addressInfo>
<roles>
<RoleInfo>
<orgName>sample string 1</orgName>
<roleName>sample string 2</roleName>
<roleCode>sample string 3</roleCode>
</RoleInfo>
<RoleInfo>
<orgName>sample string 1</orgName>
<roleName>sample string 2</roleName>
<roleCode>sample string 3</roleCode>
</RoleInfo>
</roles>
</User>
</ArrayOfUser>