All Products
Search
Document Center

CloudSSO:GetAttributePassingSetting

Last Updated:Sep 03, 2026

Queries the attribute passing settings of a specified directory to retrieve the current configuration of the SourceIdentity pass-through mode.

Operation description

You must have the cloudsso:GetAttributePassingSetting permission to call this operation. If the directory is not explicitly configured, SourceIdentityPassing returns Disabled by default.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

DirectoryId

string

Yes

The directory ID.

d-003qew84****

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

F6F90F3D-4502-5877-B80B-97476F6AE2CC

AttributePassingSetting

object

The attribute passing settings.

SourceIdentityPassing

string

The SourceIdentity pass-through mode. If not configured, Disabled is returned by default. Valid values:

  • IdP: Uses the SourceIdentity attribute value carried in the SAML assertion from the external identity provider (IdP). The attribute value must be 2 to 64 characters in length and can contain only letters, digits, and the following special characters: =,.@-_.

  • UserName: Uses the CloudSSO username as the SourceIdentity. The system automatically adds a reserved prefix, resulting in the format acs:sso:. The total length cannot exceed 64 characters.

  • Disabled: Does not pass through the SourceIdentity.

Valid values:

  • IdP :

    IdP

  • Username :

    Username

  • Disabled :

    Disabled

Disabled

Examples

Success response

JSON format

{
  "RequestId": "F6F90F3D-4502-5877-B80B-97476F6AE2CC",
  "AttributePassingSetting": {
    "SourceIdentityPassing": "Disabled"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.