UpdateCredentialProvider - Identity as a Service - Alibaba Cloud Documentation Center

Updates a credential provider.

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 supports 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:UpdateCredentialProvider

update

*CredentialProvider

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/{#CredentialProviderId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
CredentialProviderId	string	Yes	The credential provider ID.	atp_01kr2cmj5gxxx4fvmls2e93dxxxxx
ClientToken	string	Yes	The idempotency token that ensures the idempotence of the request. Generate a unique parameter value from your client to ensure uniqueness across different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters. For more information, see References: How to ensure idempotence.	client-token-example
CredentialProviderName	string	No	The credential provider name. Note The name cannot exceed 64 characters in length.	test_example_name
CredentialProviderConfig	object	No	The credential provider configuration.
OAuthProviderConfig	object	No	The configuration of the OAuth credential provider.
ClientSecret	string	No	The client_secret in the OAuth protocol. Note The value cannot exceed 1024 characters in length.	client_secret_example_xxx
TokenEndpoint	string	No	The token endpoint of the OAuth protocol. Note The value must start with `http://` or `https://` and cannot exceed 1024 characters in length.	https://example.com/token
Scope	string	No	The scope in the OAuth protocol, which specifies the permission scope. Note The Scope configuration on the credential provider serves as the fallback value. If the scope parameter is not specified when calling the DeveloperAPI to obtain an OAuth Access Token, the Scope configuration on the credential provider is used for issuance. Important Separate multiple Scope values with spaces. To clear the Scope configuration, pass an empty string. Restrictions on each individual Scope value: Allowed characters: lowercase letters, digits, and special characters `\|/:_-.` Must contain at least one lowercase letter or digit. Must start with a special character `.`, a lowercase letter, or a digit. Cannot exceed 1024 characters in length.	example:test_01 example:test_02
AuthorizationFlow	string	No	The OAuth authorization flow type. Valid values: m2m: machine-to-machine. user_federation: user federation.	m2m
AuthorizationEndpoint	string	No	The authorization endpoint.	https://example.com/authorize
ProviderVendor	string	No	The vendor type. Valid values: custom: custom. dingtalk: DingTalk. feishu: Lark. github: GitHub. microsoft: Microsoft. google: Google.	custom
DiscoveryUrl	string	No	The auto-discovery URL.	https://example.com/.well-known/openid-configuration
PkceEnabled	boolean	No	Specifies whether PKCE is enabled.	true
PkceChallengeMethod	string	No	The PKCE challenge method. Valid values: S256. plain.	S256
Issuer	string	No	The authorization server identifier URL.	https://example.com/issuer
JwtProviderConfig	object	No	The configuration of the JWT credential provider.
Expiration	integer	No	The validity period of the JWT, in seconds.	900
ExpirationCleanupEnabled	boolean	No	Specifies whether JWT expiration cleanup is enabled.	true
DerivedShortTokenEnabled	boolean	No	Specifies whether the JWT derived short token feature is enabled.	false
AllowedTokenIssuers	array	No	The list of allowed JWT issuers. Note The list cannot contain more than 200 entries. Important To clear the issuer list, pass an empty list or an empty string when calling the API.
	string	No	The allowed JWT issuer. Note The value cannot exceed 1024 characters in length.	https://test.issuer.com

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.