SetIdentityProviderUdPullConfiguration
Modifies the inbound synchronization configuration of an Identity Provider (IdP).
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The instance ID. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| IdentityProviderId |
string |
Yes |
The identity provider ID. |
idp_my664lwkhpicbyzirog3xxxxx |
| IncrementalCallbackStatus |
string |
Yes |
Specifies whether to process incremental callback data from the IdP. Valid values:
|
disabled |
| GroupSyncStatus |
string |
No |
The group synchronization status. Valid values:
|
disabled |
| UdSyncScopeConfig |
object |
No |
The inbound synchronization scope configuration. |
|
| SourceScopes |
array |
No |
The list of source nodes for synchronization. |
|
|
string |
No |
The source node for synchronization. |
ou_asdaq1addsxzdq1XXX |
|
| TargetScope |
string |
No |
The target node for synchronization. |
ou_asdaq1addsxzdq1XXX |
| PullProtectedRule |
object |
No |
The inbound synchronization protection rule. |
|
| UserDeletedThreshold |
integer |
No |
The threshold for the number of deleted accounts. If the number of deleted users exceeds this value, the synchronization task is terminated. |
30 |
| OrganizationalUnitDeletedThreshold |
integer |
No |
The threshold for the number of deleted organizational units. If the number of deleted organizational units exceeds this value, the synchronization task is terminated. |
10 |
| GroupDeletedThreshold |
integer |
No |
The threshold for the number of deleted groups. If the number of deleted groups exceeds this value, the synchronization task is terminated. |
10 |
| LdapUdPullConfig |
object |
No |
The LDAP synchronization configuration. |
|
| UserObjectClass |
string |
No |
The user ObjectClass. |
userPrincipalName, mail |
| OrganizationUnitObjectClass |
string |
No |
The organizational unit ObjectClass. |
organizationUnit,top |
| UserObjectClassCustomFilter |
string |
No |
The custom filter for users. |
(|(cn=test)(mail=test@test.com)) |
| GroupObjectClass |
string |
No |
The group ObjectClass. |
group |
| GroupMemberAttributeName |
string |
No |
The group member identifier. |
member |
| GroupObjectClassCustomFilter |
string |
No |
The custom filter for groups. |
(|(cn=test)(group=test@test.com)) |
| PeriodicSyncStatus |
string |
No |
Specifies whether to periodically verify data differences between IDaaS and the identity provider. Valid values:
|
disabled |
| PeriodicSyncConfig |
object |
No |
The periodic synchronization configuration. |
|
| PeriodicSyncType |
string |
No |
The type of periodic synchronization. |
cron |
| PeriodicSyncCron |
string |
No |
The cron expression. This parameter is required when periodicSyncType is set to cron. |
0 45 1 * * ? |
| PeriodicSyncTimes |
array |
No |
The execution time points. This parameter is required when periodicSyncType is set to time. For example, [3, 5] indicates that the task runs once between 3:00 and 4:00 and once between 5:00 and 6:00. |
|
|
integer |
No |
The execution time point. |
3 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
0441BD79-92F3-53AA-8657-F8CE4A2B912A |
Examples
Success response
JSON format
{
"RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.