All Products
Search
Document Center

CloudSSO:GetLoginPreference

Last Updated:Mar 29, 2024

Queries the logon preference of CloudSSO users.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DirectoryIdstringYes

The ID of the directory.

d-00fc2p61****

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

RequestIdstring

The request ID.

8CE8B990-193D-50CE-A604-69F3E7DCE740
LoginPreferenceobject

The logon preference.

LoginNetworkMasksstring

The IP address whitelist. CloudSSO users can log on to the CloudSSO user portal only by using the IP addresses in the whitelist.

The IP address whitelist takes effect only on CloudSSO users who want to log on to the CloudSSO user portal by using the username-password logon or single sign-on (SSO) method. The IP address whitelist does not take effect on CloudSSO users who access accounts in a resource directory from the CloudSSO user portal.

If the return value of this parameter is empty, no IP address whitelists are configured.

192.168.0.0/16;10.0.0.0/8

Examples

Sample success responses

JSONformat

{
  "RequestId": "8CE8B990-193D-50CE-A604-69F3E7DCE740",
  "LoginPreference": {
    "LoginNetworkMasks": "192.168.0.0/16;10.0.0.0/8"
  }
}

Error codes

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