Help Center/ Identity and Access Management/ API Reference/ API/ Federated Identity Authentication Management/ Identity Providers/ Querying Identity Provider Details
Updated on 2025-12-27 GMT+08:00
View PDF

Querying Identity Provider Details

Function

This API is used to query the details about an identity provider.

The API can be called using both the global endpoint and region-specific endpoints.

Authorization Information

Each account is authorized to call all APIs, but its IAM users must obtain the required permissions. For details, see Permissions and Supported Actions.

URI

GET /v3/OS-FEDERATION/identity_providers/{id}

Table 1 URI parameters

Parameter

Mandatory

Type

Description

id

Yes

String

ID of the identity provider to be queried.

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Fill application/json;charset=utf8 in this field.

X-Auth-Token

Yes

String

IAM user token (no special permission requirements).

Response Parameters

Table 3 Parameters in the response body

Parameter

Type

Description

identity_provider

Object

Identity provider information.
Table 4 identity_provider

Parameter

Type

Description

sso_type

String

Identity provider type. The following two types are supported:

  • virtual_user_sso: The federated user is mapped to a virtual user after the login is redirected.
  • iam_user_sso: The federated user is mapped to an IAM user after the login is redirected.

The default value is virtual_user_sso.

id

String

Identity provider ID.

description

String

Description of the identity provider.

enabled

Boolean

Enabling status of the identity provider. true indicates that the identity provider is enabled. false indicates that the identity provider is disabled. The default value is false.

remote_ids

Array of strings

List of federated user IDs configured for the identity provider.

links

Object

Identity provider resource link.
Table 5 identity_provider.links

Parameter

Type

Description

self

String

Identity provider resource link.

protocols

String

Protocol resource link.

Example Request

Request for querying identity provider details

GET https://iam.myhuaweicloud.eu/v3/OS-FEDERATION/identity_providers/{id}

Example Response

Status code: 200

The request is successful.

{
    "identity_provider": {
        "remote_ids": [],
        "enabled": true,
        "id": "ACME",
        "sso_type": "iam_user_sso",
        "links": {
            "self": "https://iam.myhuaweicloud.eu/v3/OS-FEDERATION/identity_providers/ACME",
            "protocols": "https://iam.myhuaweicloud.eu/v3/OS-FEDERATION/identity_providers/ACME/protocols"
        },
        "description": "Stores ACME identities."
    }
}

Status Codes

Status Code

Description

200

The request is successful.

400

Invalid parameters.

401

Authentication failed.

403

Access denied.

404

The requested resource cannot be found.

405

The method specified in the request is not allowed for the requested resource.

413

The request entity is too large.

500

Internal server error.

503

Service unavailable.

Error Codes

None

Parent topic: Identity Providers