UpdateSAMLProvider - Resource Access Management - Alibaba Cloud Documentation Center

Operation description

This example shows how to change the description of the identity provider test-provider to This is a new 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

ram:UpdateSAMLProvider

update

*SAMLProvider

acs:ram::{#accountId}:saml-provider/{#SAMLProviderName}

None

Request parameters

Parameter	Type	Required	Description	Example
SAMLProviderName	string	Yes	The name of the identity provider to modify.	test-provider
NewDescription	string	No	The new description. Note Specify at least one of the `NewDescription` and `NewEncodedSAMLMetadataDocument` parameters.	This is a new provider.
NewEncodedSAMLMetadataDocument	string	No	The new metadata file. Note Specify at least one of the `NewDescription` and `NewEncodedSAMLMetadataDocument` parameters.	PD94bWwgdmVy****
AuthnSignAlgo	string	No	The signature algorithm supported by the Alibaba Cloud service provider (SP). Valid values: rsa-sha256 rsa-sha1	rsa-sha1

Response elements

Element	Type	Description	Example
	object	The returned result.
RequestId	string	The request ID.	E5EDDFD2-3654-4F9F-9780-4AE7D81823EF
SAMLProvider	object	The information about the identity provider.
UpdateDate	string	The time when the identity provider was last updated. The time is in Coordinated Universal Time (UTC).	2020-10-22T02:51:20Z
Description	string	The description.	This is a new provider.
SAMLProviderName	string	The name of the identity provider.	test-provider
CreateDate	string	The time when the identity provider was created. The time is in UTC.	2020-10-22T02:37:05Z
Arn	string	The Alibaba Cloud Resource Name (ARN) of the identity provider.	acs:ram::177242285274****:saml-provider/test-provider
AuthnSignAlgo	string	The signature algorithm supported by the Alibaba Cloud SP. Valid values: rsa-sha256 rsa-sha1	rsa-sha1

Examples

Success response

JSON format

{
  "RequestId": "E5EDDFD2-3654-4F9F-9780-4AE7D81823EF",
  "SAMLProvider": {
    "UpdateDate": "2020-10-22T02:51:20Z",
    "Description": "This is a new provider.",
    "SAMLProviderName": "test-provider",
    "CreateDate": "2020-10-22T02:37:05Z",
    "Arn": "acs:ram::177242285274****:saml-provider/test-provider",
    "AuthnSignAlgo": "rsa-sha1"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.