Update identity source connection
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.
Update the identity source connection, you can set the identity source icon, whether to support login only, etc.
Method name
ManagementClient.update_ext_idp_conn
Request parameters
| Name | Type | Required | Default value | Description | Example value |
|---|---|---|---|---|---|
| fields | object | Yes | - | Identity source connection custom parameters (incremental modification) | {"clientId":"clientId"} |
| displayName | string | Yes | - | Identity source connection display name | exampleName |
| id | string | Yes | - | Identity source connection ID | 60b49eb83fd80adb96f26e68 |
| logo | string | no | - | Icon for identity source connection | https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png |
| loginOnly | boolean | no | - | Whether to support login only | |
| tenantId | string | no | - | Tenant ID | 60b49eb83fd80adb96f26e68 |
Request Response
Type: ExtIdpConnDetailSingleRespDto
| 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 (successful request does not return). For a detailed list of error codes, see: API Code List |
| requestId | string | Request ID. Returned when the request fails. |
Data Structure
ExtIdpConnDetail
| Name | Type | Is it required? | Description | Sample value |
|---|---|---|---|---|
| id | string | Yes | Identity source connection id | 60b49eb83fd80adb96f26e68 |
| type | string | Yes | Identity source connection type | oidc |
| extIdpId | string | Yes | Identity source ID | 6318061be13c0ce6a64093e5 |
| logo | string | Yes | Identity source connection icon | https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png |
| identifier | string | No | Identity source connection identifier | 60b49eb83fd80adb96f26e68 |
| displayName | string | No | Display name of the identity source connection on the login page | LoginPage |
| loginOnly | boolean | Yes | Whether to support only login | true |
| associationMode | string | Yes | Account association mode | none |
| challengeBindingMethods | array | Yes | Account binding method | ["email-password"] |