GetIdentityProviderUdPushConfiguration - Identity as a Service

Retrieve the IdP outbound synchronization configuration.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID	eiam-111ccc1111
IdentityProviderId	string	Yes	Identity provider ID	idp_11111

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID	0441BD79-92F3-53AA-8657-F8CE4A2B912A
UdPushConfiguration	object	Outbound synchronization configuration
InstanceId	string	Instance ID	idaas_7vdv3olzk36gymwtlaq6fixxxx
IdentityProviderId	string	Identity provider ID	idp_na2rzpyc67zr7ixdfy35zgrxxx
IncrementalCallbackStatus	string	Incremental callback status. Indicates whether incremental callback data from the IdP is processed.	enabled
UdSyncScopeConfigs	array<object>	Outbound synchronization configuration details
	object	Outbound synchronization configuration details
SourceScopes	array	Source nodes for synchronization
	string	Source node for synchronization	ou_12121xxxx
TargetScope	string	Target node for synchronization	604352338
LdapUdPushConfig	object	LDAP synchronization-side configuration
UserObjectClass	string	User ObjectClass	user,top
OrganizationUnitObjectClass	string	Organization ObjectClass	ou,top
UserRdn	string	User RDN	cn
OrganizationalUnitRdn	string	Organization RDN	ou
PasswordSyncStatus	string	Password synchronization status	enabled
PeriodicSyncConfig	object	Periodic verification configuration
PeriodicSyncType	string	Type	cron
PeriodicSyncCron	string	Cron expression	0 45 1 * * ?
PeriodicSyncTimes	array	Collection of time points
	string	Time point	3
PeriodicSyncStatus	string	Periodic verification status	disabled

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "UdPushConfiguration": {
    "InstanceId": "idaas_7vdv3olzk36gymwtlaq6fixxxx",
    "IdentityProviderId": "idp_na2rzpyc67zr7ixdfy35zgrxxx",
    "IncrementalCallbackStatus": "enabled",
    "UdSyncScopeConfigs": [
      {
        "SourceScopes": [
          "ou_12121xxxx"
        ],
        "TargetScope": "604352338"
      }
    ],
    "LdapUdPushConfig": {
      "UserObjectClass": "user,top",
      "OrganizationUnitObjectClass": "ou,top",
      "UserRdn": "cn",
      "OrganizationalUnitRdn": "ou",
      "PasswordSyncStatus": "enabled"
    },
    "PeriodicSyncConfig": {
      "PeriodicSyncType": "cron",
      "PeriodicSyncCron": "0 45 1 * * ?",
      "PeriodicSyncTimes": [
        "3"
      ]
    },
    "PeriodicSyncStatus": "disabled"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.