All Products
Search

This Product

    CloudSSO:GetUserId

    Document Center

    CloudSSO:GetUserId

    Last Updated:Jun 14, 2024

    Queries the ID of a user in a resource directory by using the ExternalId parameter.

    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 resource directory.

    		d-00fc2p61****
    ExternalIdobjectYes

    The identifier information about the user that is synchronized from an external identity provider (IdP).

    IdstringYes

    The identifier of the user that is synchronized from an external IdP.

    		c73******a5fdd5
    IssuerstringYes

    The method for external identity synchronization. Only System for Cross-domain Identity Management (SCIM) synchronization is supported.

    		SCIM

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		A3A41736-A050-50B6-ABC5-590F376A0044
    UserIdstring

    The ID of the CloudSSO user.

    		u-d8d1iox****

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "A3A41736-A050-50B6-ABC5-590F376A0044",
  "UserId": "u-d8d1iox****"
}

    Error codes

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