Identity source connection switch
This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If this document description is incorrect, please refer to V3 API.
Identity source connection switch, you can turn on or off the identity source connection.
Method name
ManagementClient.change_ext_idp_conn_state
Request parameters
| Name | Type | Is it required? | Default value | Description | Sample value |
|---|---|---|---|---|---|
| appId | string | yes | - | Application ID | 60b49eb83fd80adb96f26e68 |
| enabled | boolean | yes | - | Whether to enable identity source connection | |
| id | string | yes | - | Identity source connection ID | 60b49eb83fd80adb96f26e68 |
| tenantId | string | No | - | Tenant ID | 60b49eb83fd80adb96f26e68 |
| appIds | string[] | No | - | Application ID list |
Request Response
Type: IsSuccessRespDto
| Name | Type | Description |
|---|---|---|
| statusCode | number | Business status code, which can be used to determine whether the operation is successful. 200 means success. |
| message | string | Description |
| apiCode | number | Segmented error code, which can be used to get the specific error type (not returned for successful requests). For a detailed list of error codes, see: API Code List |
| requestId | string | Request ID. Returned when the request fails. |
| data | <a IsSuccessDto | Whether the operation is successful |
Sample result:
json
{
"statusCode": 200,
"message": "Success",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
"data": {
"success": true
}
}Data Structure
IsSuccessDto
| Name | Type | Is it required | Description | Example value |
|---|---|---|---|---|
| success | boolean | yes | Whether the operation was successful | true |