SetApplicationProvisioningConfig - Identity as a Service

Sets the account synchronization configuration for an EIAM application.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eiam:SetApplicationProvisioningConfig

update

*Application

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	eiam-111ccc1111
ApplicationId	string	Yes	The application ID.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
ProvisionProtocolType	string	Yes	The account synchronization protocol. Valid values: idaas_callback: IDaaS custom event callback for account synchronization. scim2: System for Cross-domain Identity Management (SCIM) protocol for synchronization.	idaas_callback
CallbackProvisioningConfig	object	No	The application event callback synchronization configuration. This parameter is required when ProvisionProtocolType is set to idaas_callback.
CallbackUrl	string	No	The destination address where the application accepts IDaaS event callbacks.	https://example.com/event/callback
EncryptKey	string	No	The symmetric key for encrypting and decrypting IDaaS event callbacks. The key uses the AES-256 algorithm and is in hexadecimal format.	ad3b248**************************b3561a73d7
EncryptRequired	boolean	No	Indicates whether to encrypt IDaaS event callback messages. Valid values: true: Encrypt the messages. false: Do not encrypt the messages. The messages are transmitted in plaintext.	true
ListenEventScopes	array	No	The list of message types for the IDaaS event callback listener.
	string	No	The message type for the IDaaS event callback listener. For more information about valid values, see Callback events.	urn:alibaba:idaas:app:event:ud:user:create
ScimProvisioningConfig	object	No	The IDaaS SCIM protocol synchronization configuration parameters. This parameter is required when ProvisionProtocolType is set to scim2.
ScimBaseUrl	string	No	The base URL where the application accepts IDaaS SCIM protocol synchronization.	https://example.com/scim
AuthnConfiguration	object	No	The configuration parameters for SCIM protocol synchronization.
AuthnMode	string	No	The authorization mode for the SCIM protocol interface. Valid values: oauth2: OAuth2 mode.	oauth2
GrantType	string	No	The authorization grant type for the SCIM protocol. Valid values: client_credentials: Client credentials mode. bearer_token: Bearer token mode.	bearer_token
AuthnParam	object	No	The authorization configuration parameters. The usage is as follows: If GrantType is set to client_credentials, you can update ClientId, ClientSecret, and AuthnMethod. If GrantType is set to bearer_token, you can update AccessToken.
AccessToken	string	No	The access token. You can update this field when the grant type is bearer_token.	k52x2ru63rlkflina5utgkxxxx
TokenEndpoint	string	No	The token endpoint.	https://www.example.com/oauth/token
ClientId	string	No	The client ID of the application.	mkv7rgt4d7i4u7zqtzev2mxxxx
ClientSecret	string	No	The client secret of the application.	CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx
AuthnMethod	string	No	The authentication method for the SCIM protocol. Valid values: client_secret_basic: The key is passed in the request header. client_secret_post: The key is passed in the request body.	client_secret_basic
ProvisioningActions	array	No	The operations on the target resource for the SCIM protocol. Valid values: urn:alibaba:idaas:app:scim:User:CREATE: Create an account. urn:alibaba:idaas:app:scim:User:UPDATE: Update an account. urn:alibaba:idaas:app:scim:User:DELETE: Delete an account.
	string	No	The operation on the target resource for the SCIM protocol.	urn:alibaba:idaas:app:scim:User:CREATE
FullPushScopes	array	No	The scope of a full push for the SCIM protocol. Valid values: urn:alibaba:idaas:app:scim:User:PUSH: Full synchronization of users.
	string	No	The scope of a full push for the SCIM protocol.	urn:alibaba:idaas:app:scim:User:PUSH
ProvisionPassword	boolean	No	Indicates whether to synchronize passwords for IDaaS user event callbacks. Valid values: true: Synchronize passwords. false: Do not synchronize passwords.	true
NetworkAccessEndpointId	string	No	The network endpoint ID.	nae_examplexxxx

Response parameters

Parameter	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

HTTP status code	Error code	Error message	Description
400	InvalidParameter.ListenEventScopes	The specified event scope contains an unsupported event type.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.