GetIdentityProviderUdPullConfiguration - Identity as a Service

Get IdP Inbound Synchronization Configuration Information

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
eiam:GetIdentityProviderUdPullConfiguration	get	*IdentityProvider `acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
IdentityProviderId	string	Yes	Identity provider ID	idp_my664lwkhpicbyzirog3xxxxx

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
UdPullConfiguration	object	Inbound Synchronization Configuration Information
InstanceId	string	The ID of the instance.	idaas_ue2jvisn35ea5lmthk267xxxxx
IdentityProviderId	string	Identity provider ID	idp_my664lwkhpicbyzirog3xxxxx
IncrementalCallbackStatus	string	Incremental Callback Status: Whether to process incremental callback data from the IdP	enabled
PeriodicSyncStatus	string	Scheduled Validation Status: Whether to periodically validate data discrepancies between IDaaS and the Identity Provider. Possible values: Disabled: disabled Enabled: enabled	enabled
GroupSyncStatus	string	Group Synchronization Status Possible values: Disabled: disabled Enabled: enabled	enabled
UdSyncScopeConfig	object	Synchronization Scope Configuration Information
SourceScopes	array	Synchronization Source Node
SourceScop	string	Synchronization Source Node	960
TargetScope	string	Synchronization Target Node	ou_asjdfhaskfhw213mnsj33sXXX
PullProtectedRule	object	Inbound Synchronization Protection Rule Configuration
UserDeletedThreshold	integer	Account Deletion Threshold: If the number of deleted users exceeds this value, the synchronization task will be terminated.	30
OrganizationalUnitDeletedThreshold	integer	Organization Deletion Threshold: If the number of deleted organizations exceeds this value, the synchronization task will be terminated.	10
GroupDeletedThreshold	integer	Group Deletion Threshold: If the number of deleted groups exceeds this value, the synchronization task will be terminated.	10
LdapUdPullConfig	object	LDAP Synchronization Side Related Configuration Information
UserObjectClass	string	User ObjectClass	ou,top
OrganizationUnitObjectClass	string	Organization ObjectClass	ou,top
UserObjectClassCustomFilter	string	User ObjectClass Custom Filter	(\|(cn=test)(mail=test@test.com))
GroupObjectClass	string	Group ObjectClass	member
GroupMemberAttributeName	string	Group Member Identifier	group
GroupObjectClassCustomFilter	string	Group Custom Filter	(\|(cn=test)(group=test@test.com))
PeriodicSyncConfig	object	Scheduled sync configuration
PeriodicSyncType	string	type	cron
PeriodicSyncCron	string	Cron expression	0 45 1 * * ?
PeriodicSyncTimes	integer	Execution time slots, for example 3,5, meaning the task runs once between 03:00–04:00 and once between 05:00–06:00.	[3,5]

Examples

Sample success responses

JSONformat

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "UdPullConfiguration": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "IdentityProviderId": "idp_my664lwkhpicbyzirog3xxxxx\n",
    "IncrementalCallbackStatus": "enabled",
    "PeriodicSyncStatus": "enabled",
    "GroupSyncStatus": "enabled",
    "UdSyncScopeConfig": {
      "SourceScopes": [
        960
      ],
      "TargetScope": "ou_asjdfhaskfhw213mnsj33sXXX"
    },
    "PullProtectedRule": {
      "UserDeletedThreshold": 30,
      "OrganizationalUnitDeletedThreshold": 10,
      "GroupDeletedThreshold": 10
    },
    "LdapUdPullConfig": {
      "UserObjectClass": "ou,top",
      "OrganizationUnitObjectClass": "ou,top",
      "UserObjectClassCustomFilter": "(|(cn=test)(mail=test@test.com))",
      "GroupObjectClass": "member",
      "GroupMemberAttributeName": "group",
      "GroupObjectClassCustomFilter": "(|(cn=test)(group=test@test.com))"
    },
    "PeriodicSyncConfig": {
      "PeriodicSyncType": "cron",
      "PeriodicSyncCron": "0 45 1 * * ?",
      "PeriodicSyncTimes": 0
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.