All Products
Search
Document Center

Resource Access Management:SetUserSsoSettings

Last Updated:Mar 03, 2024

Configures information about identity providers (IdPs) for user-based single sign-on (SSO).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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:SetUserSsoSettingsWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
MetadataDocumentstringNo

The metadata file, which is Base64-encoded.

The file is provided by an IdP that supports SAML 2.0.

PD94bWwgdmVy****
SsoEnabledbooleanNo

Specifies whether to enable SSO for the RAM user. Default value: false. Valid values:

  • true
  • false
true
AuxiliaryDomainstringNo

The auxiliary domain name.

example.com

Response parameters

ParameterTypeDescriptionExample
object
UserSsoSettingsobject

The configurations of user-based SSO.

AuxiliaryDomainstring

The auxiliary domain name.

example.com
MetadataDocumentstring

The metadata file, which is Base64-encoded.

PD94bWwgdmVy****
SsoEnabledboolean

Indicates whether user-based SSO is enabled.

true
RequestIdstring

The ID of the request.

87F2E3F6-28A0-43F3-A77F-F7760E62F61E

Examples

Sample success responses

JSONformat

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

Error codes

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