Get Service Status
Description
Get the cloud service information and authentication status under the same business unit.
URL
/api/v1/service/status/{service}
Method: Get
Request Headers
|
Key |
Value |
Type |
Description |
|---|---|---|---|
| Authorization | Bearer <Authorization Token> | String | Authorization credential generated by FortiCASB |
| Content-Type | application/json | String | |
|
buId |
<Business Unit ID> |
Long |
The targeted business unit ID on FortiCASB. Business unit ID can be obtained through . Alternatively, it can also be obtained from the REST API Get Resource Map |
|
service |
<Cloud Service> |
String |
Cloud service name such as Salesforce, Office365, etc. |
| companyId | <Company ID> | Integer | Company ID of which the business unit is under, can be obtained through Get Resource Map. |
|
roleId |
<User ID> |
Integer |
Login user ID, can be obtained through Get Resource Map. |
Sample Request
|
Request URL |
GET https://www.forticasb.com/api/v1/service/status/Salesforce |
| Request Header |
Authorization: Bearer <Authorization_Token> Content-Type: application/json roleId: 36241 companyId: 62598 buid: 6384 |
Response Variables
|
Name |
Required |
Type |
Description |
|---|---|---|---|
| step | Required | String | The operation step at this stage |
| total | Required | int | The number of steps |
| processing | Required | int | Number of processing steps |
| actionStatusCode | Required | ActionStatusCode | The result code of this stage's operation |
| code | Required | String | Add cloud service status code |
| stepOrder | Required | int | The order of the related operation |
| casbUser | Optional | String | The user email that is used in FortiCASB |
| cloudUser | Optional | String | The user name that is registered with the cloud service |
| date | Optional | long | Timestamp, the time that this cloud service is added into FortiCASB |
| process | Optional | List<OAuthProcess> | The processes of the getting this cloud service's OAuth |
| message | Optional | String | The message with the process |
Sample Response
{
"code": "100",
"casbUser": "qa.casb1@gmail.com",
"cloudUser": "yuezhang@yue.com",
"date": 1583432355315,
"process": [
{
"step": "OAuth Request",
"total": 1,
"processing": 1,
"actionStatusCode": "100",
"message": "",
"stepOrder": 1
},
{
"step": "Check License",
"total": 1,
"processing": 1,
"actionStatusCode": "100",
"message": "",
"stepOrder": 2
},
{
"step": "Update OAuth Data",
"total": 1,
"processing": 1,
"actionStatusCode": "100",
"message": "",
"stepOrder": 3
},
{
"step": "Initial Data Pulling Logic",
"total": 1,
"processing": 1,
"actionStatusCode": "100",
"message": "",
"stepOrder": 5
},
{
"step": "Remove old OAuth data",
"total": 1,
"processing": 1,
"actionStatusCode": "100",
"message": "",
"stepOrder": 5
}
]
}