All Products
Search

This Product

    CloudSSO:UpdateAttributePassingSetting

    Document Center

    CloudSSO:UpdateAttributePassingSetting

    Last Updated:Sep 03, 2026

    Updates the attribute passing settings for a specified directory, allowing you to set the SourceIdentity pass-through mode to IdP, UserName, or Disabled.

    Operation description

    You must have the cloudsso:UpdateAttributePassingSetting permission to call this operation. If the SourceIdentityPassing request parameter is not specified, the existing value is retained. If an invalid enum value is specified, the InvalidParameter.SourceIdentityPassing error is returned.

    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-00fc2p61****
    SourceIdentityPassing

    string

    No

    The SourceIdentity pass-through mode. Three pass-through modes are supported. If this parameter is not specified, the existing configuration is not modified.

    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:, with a total length of no more than 64 characters.

    • Disabled: Does not pass through SourceIdentity.

    Valid values:

    • IdP :

      IdP

    • Username :

      Username

    • Disabled :

      Disabled

    Disabled

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    63160579-2E1B-57B0-8273-B27427172385

    Examples

    Success response

    JSON format

    {
  "RequestId": "63160579-2E1B-57B0-8273-B27427172385"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.