SaaS製品認証情報取得
OpenAPI説明
当該OpenAPIは、個別にテナントIDを指定して、外部SaaS製品の認証情報を照会する。
OpenAPI権限
当該OpenAPIはテナント権限が必要です。
リクエストURI
/api/openapi/externalService/authenticationInfo
リクエスト形式
GET
リクエストパラメータ例
- /api/openapi/externalService/authenticationInfo?serviceCode=0
リクエストパラメータ説明
| 項目 | タイプ | 必須 | 制限 | 説明 |
|---|---|---|---|---|
| serviceCode | String | 最大2文字 | SaaSコード 0:BillOne 1:日本ICS請求書管理オプション |
OpenAPIリターン例
{
"tenantId": "1214732595705114600",
"authenticationInfos": [
{
"serviceCode": "0",
"serviceName": "BillOne",
"clientId": "24a67f14-8uy9-4143-b69b-316607b86ip9",
"clientSecret": "OUYE4YzM1MDctOTE2NC00MDc5YUIzN2UtMTlmNzA1YzE4YjNB2",
"refreshToken": "f609ee9c-88f0-4d88-9210-a5da0a3cd41d",
"receivingDepartment": "DxCG連携用受領部門",
"status": true
},
{
"serviceCode": "1",
"serviceName": "日本ICS請求書管理オプション",
"clientId": "24a67f14-8uy9-2342-b69b-3889607b86opi",
"clientSecret": "WERE4YzM1MDctOTE2NC00MDc5YUIzN2UtMTlmNzA1YzE4YjNB45",
"refreshToken": "wqrqwe9c-88f0-4d88-9210-a5da0a3c42ef",
"receivingDepartment": "",
"status": true
}
]
}
OpenAPIリターン項目
| パラメータ名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| tenantId | String | テナントID | |
| authenticationInfos | authenticationInfo[] | 外部SaaS製品の認証情報 |
authenticationInfo
| パラメータ名 | タイプ | 規則 | 説明 |
|---|---|---|---|
| serviceCode | String | SaaSコード | |
| serviceName | String | SaaS名 | |
| clientId | String | client_id | |
| clientSecret | String | client_secret | |
| refreshToken | String | リフレッシュトークン | |
| receivingDepartment | String | 受領部門取得元ラベル名 | |
| status | Boolean | ステータス true:有効 false:無効 |
失敗例
{
"message": "テナントの権限がありません",
"errorCode": "120001"
}
項目説明
| 項目名 | タイプ | 説明 |
|---|---|---|
| message | String | メッセージを返す |
| errorCode | String | エラーコードを返す |
エラーコード説明
| errorCode | message | 説明 |
|---|---|---|
| 120001 | テナントの権限がありません | |
| spd.32741.012 | Saasコードが不正です。 |