CreateSAMLProvider - Resource Access Management - Alibaba Cloud Documentation Center

Creates an identity provider (IdP) for role-based single sign-on (SSO).

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:CreateSAMLProvider

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SAMLProviderName	string	Yes	The IdP name. It can be up to 128 characters in length, and can contain letters, digits, `periods (.), hyphens (-), and underscores (_)`. The name cannot start or end with `periods (.), hyphens (-), or underscores (_)`.	test-provider
Description	string	No	The IdP escription.	This is a provider.
EncodedSAMLMetadataDocument	string	No	The metadata file, which is Base64-encoded. The file is provided by an IdP that supports Security Assertion Markup Language (SAML) 2.0.	PD94bWwgdmVy****
AuthnSignAlgo	string	No	The supported signature algorithm. Valid values: rsa-sha256 rsa-sha1 (default)	rsa-sha1

Response elements

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

Examples

Success response

JSON format

{
  "RequestId": "E5EDDFD2-3654-4F9F-9780-4AE7D81823EF",
  "SAMLProvider": {
    "UpdateDate": "2020-10-22T02:51:20Z",
    "Description": "This is a 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.