All Products
Search
Document Center

Resource Access Management:GetUserSsoSettings

Last Updated:Jan 20, 2025

Queries the configurations of user-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:GetUserSsoSettingsget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

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.

false
SsoLoginWithDomainboolean

Indicates whether the Security Assertion Markup Language (SAML) SSO requires a domain name in the <saml:NameID> element of the SAML response. If yes, the username specified by the identity provider (IdP) for SSO must have a domain name as the suffix.

  • If the value of the parameter is true, the <saml:NameID> element must be in the username@domain format. You can set domain to the default domain name or the configured domain alias.
  • If the value of the parameter is false, the <saml:NameID> element must be in the username format and cannot contain the domain suffix.

The default value is true.

true
RequestIdstring

The request ID.

69FC3E5E-D3D9-434B-90CA-BBA8E0551A47

Examples

Sample success responses

JSONformat

{
  "UserSsoSettings": {
    "AuxiliaryDomain": "example.com",
    "MetadataDocument": "PD94bWwgdmVy****",
    "SsoEnabled": false,
    "SsoLoginWithDomain": true
  },
  "RequestId": "69FC3E5E-D3D9-434B-90CA-BBA8E0551A47"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-12-09The response structure of the API has changedView Change Details
2024-08-14API Description UpdateView Change Details