SetUserSsoSettings - Resource Access Management - Alibaba Cloud Documentation Center

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MetadataDocument	string	No	The metadata file. The file must be Base64-encoded. The file is provided by an identity provider (IdP) that supports the Security Assertion Markup Language (SAML) 2.0 protocol.	PD94bWwgdmVy****
SsoEnabled	boolean	No	Specifies whether to enable user-based SSO for Resource Access Management (RAM) users. Valid values: true: Enables user-based SSO. false (default): Disables user-based SSO.	true
AuxiliaryDomain	string	No	The auxiliary domain name.	example.com
SsoLoginWithDomain	boolean	No	Specifies whether the `<saml:NameID>` element in a SAML response must contain a domain name when a user logs on using SAML-based SSO. This applies if the username that is specified on the IdP for logon matching contains a domain name suffix. If this parameter is set to `true`, the value of the `<saml:NameID>` element must be in the `username@domain` format, which includes a domain name suffix. The `domain` can be the default domain name or a domain alias if one is configured. If this parameter is set to `false`, the value of the `<saml:NameID>` element must be the `username` only. The value must not contain the `domain` part. The default value is `true`.	true
AuthnSignAlgo	string	No	The signature algorithm that is supported by the Alibaba Cloud service provider (SP). Valid values: rsa-sha256 rsa-sha1 (default)	rsa-sha1

Response elements

Element	Type	Description	Example
	object
UserSsoSettings	object	The user-based SSO settings.
AuxiliaryDomain	string	The auxiliary domain name.	example.com
MetadataDocument	string	The metadata file. The file is Base64-encoded.	PD94bWwgdmVy****
SsoEnabled	boolean	Indicates whether user-based SSO is enabled.	true
SsoLoginWithDomain	boolean	Indicates whether the `<saml:NameID>` element in a SAML response must contain a domain name when a user logs on using SAML-based SSO. This applies if the username that is specified on the IdP for logon matching contains a domain name suffix. If this parameter is set to `true`, the value of the `<saml:NameID>` element must be in the `username@domain` format, which includes a domain name suffix. The `domain` can be the default domain name or a domain alias if one is configured. If this parameter is set to `false`, the value of the `<saml:NameID>` element must be the `username` only. The value must not contain the `domain` part. The default value is `true`.	true
AuthnSignAlgo	string	The signature algorithm that is supported by the Alibaba Cloud SP. Valid values: rsa-sha256 rsa-sha1 (default)	rsa-sha1
RequestId	string	The request ID.	87F2E3F6-28A0-43F3-A77F-F7760E62F61E

Examples

Success response

JSON format

{
  "UserSsoSettings": {
    "AuxiliaryDomain": "example.com",
    "MetadataDocument": "PD94bWwgdmVy****",
    "SsoEnabled": true,
    "SsoLoginWithDomain": true,
    "AuthnSignAlgo": "rsa-sha1"
  },
  "RequestId": "87F2E3F6-28A0-43F3-A77F-F7760E62F61E"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.