All Products
Search
Document Center

Resource Access Management:CreateSAMLProvider

Last Updated:Jan 20, 2025

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ram:CreateSAMLProvidercreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SAMLProviderNamestringYes

The name of the IdP.

The name can be up to 128 characters in length. The name can contain letters, digits, periods (.), hyphens (-), and underscores (_). The name cannot start or end with periods (.), hyphens (-), or underscores (_).

test-provider
DescriptionstringNo

The description.

This is a provider.
EncodedSAMLMetadataDocumentstringYes

The metadata file which is Base64-encoded.

The file is provided by an IdP that supports Security Assertion Markup Language (SAML) 2.0.

PD94bWwgdmVy****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

A95A763D-F6B7-5242-83EB-AB45CE67F358
SAMLProviderobject

The information about the IdP.

UpdateDatestring

The update time. The time is displayed in UTC.

2020-10-22T02:51:20Z
Descriptionstring

The description.

This is a provider.
SAMLProviderNamestring

The name of the IdP.

test-provider
CreateDatestring

The creation time. The time is displayed in UTC.

2020-10-22T02:37:05Z
Arnstring

The Alibaba Cloud Resource Name (ARN) of the IdP.

acs:ram::177242285274****:saml-provider/test-provider

Examples

Sample success responses

JSONformat

{
  "RequestId": "A95A763D-F6B7-5242-83EB-AB45CE67F358",
  "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"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-08-14API Description UpdateView Change Details