Get User List
Description
Get details of all users of the cloud services under the same company and business unit.
URL
api/v1/profile/user/list
Method: Get
Request Header
|
Key |
Value |
Type |
Description |
|---|---|---|---|
| companyId | <Company ID> | Integer | Company ID |
| Authorization | Bearer <Authorization Token> | String | Authorization credential generated by FortiCASB |
|
buId |
<Business Unit ID> |
Long |
The targeted business unit ID on FortiCASB. Business unit ID can be obtained through View or Remove Business User. Alternatively, it can also be obtained from the REST API Get Resource Map |
|
service |
<Cloud Service> |
String |
Name of the cloud service such as Salesforce, Office365, etc. |
| Content-Type | application/json | String | |
|
skip |
<Skip Number> |
Integer |
Indexes in a result set. Used to exclude response from the first N items of a resource collection. |
|
limit |
<Limit per Page> |
Integer |
Maximum number of return items per page. |
Sample Request
|
Request URL |
GET https://www.forticasb.com/api/v1/profile/user/list |
| Request Header |
Authorization: Bearer <Authorization_Token> Content-Type: application/json service: Salesforce buid: 8 companyid: 7 skip: 0 limit: 2 |
Response Variable
|
Name |
Required |
Type |
Description |
|---|---|---|---|
| companyId | Required | Long | Company ID |
| userId | Required | String | The user identity |
| origUserId | Required | String | The original user identity |
| deleted | Required | boolean | The current user information deleted or not |
| createdDate | Required | long | Timestamp, user created date |
| service | Required | Application | Cloud service name |
| isActive | Required | boolean | User active status |
| buId | optional | Long | Business unit ID |
| createdById | optional | String | The ID which created this user |
| lastModifiedDate | optional | long | Timestamp, the last time that this user has been modified |
| lastModifiedById | optional | String | The last user id that modified this user information |
| lastLoginDate | optional | long | Timestamp, the last time that this user login into FortiCASB |
| systemModstamp | optional | long | Timestamp of the system |
| optional | String | The email of the registered user | |
| userName | optional | String | The user name of the registered user |
| name | optional | String | This user's name |
| firstName | optional | String | This user's first name |
| lastName | optional | String | This user's last name |
| userType | optional | UserTypeEnum | User type |
| profileId | optional | String | This user's profile ID |
| userRoleId | optional | String | This user's role ID |
Sample Response
[
{
"companyId": "7",
"buId": 8,
"userId": "0050P000006kOBcQAM",
"origUserId": "0050P000006kOBcQAM",
"deleted": false,
"createdDate": 1492555111000,
"createdById": "0050P000006d7J0QAI",
"lastModifiedDate": 1583370489000,
"systemModstamp": 1545262127000,
"email": "xxxxxxx@gmail.com",
"userName": "xxxxxxx@guest.hotmail.com",
"name": "forti3 net3",
"firstName": "forti3",
"lastName": "net3",
"service": "SALESFORCE",
"lastLoginDate": 1545262127000,
"userType": "CsnOnly",
"isActive": true,
"profileId": "00e0P000000JYKPQA4"
},
{
"companyId": "7",
"buId": 8,
"userId": "0054U000009GCaMQAW",
"origUserId": "0054U000009GCaMQAW",
"deleted": false,
"createdDate": 1595303943000,
"createdById": "0050P000006d7J1QAI",
"lastModifiedDate": 1595303943000,
"systemModstamp": 0,
"email": "xxxxx@salesforce.com",
"userName": "xxxxxx@00d0p000000db1xuas",
"name": "Platform Integration User",
"lastName": "Platform Integration User",
"service": "SALESFORCE",
"lastLoginDate": 0,
"isActive": true,
"profileId": "00e0P000000a7HVQAY"
}
]