Help Center> Identity and Access Management> API Reference> API> Federated Identity Authentication Management> Identity Providers> Listing Identity Providers
View PDF

Listing Identity Providers

Function

This API is used to list all identity providers.

The API can be called using both the global endpoint and region-specific endpoints. For IAM endpoints, see Regions and Endpoints.

URI

GET /v3/OS-FEDERATION/identity_providers

Request Parameters

Table 1 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 2 Parameters in the response body

Parameter

Type

Description

identity_providers

Array of objects

Identity provider information.

links

Object

Resource link information.
Table 3 identity_providers

Parameter

Type

Description

sso_type

string

Identity provider type. virtual_user_sso and iam_user_sso are supported. When an empty string or null is returned, the default type virtual_user_sso is used.

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 4 identity_providers.links

Parameter

Type

Description

self

String

Identity provider resource link.

protocols

String

Protocol resource link.
Table 5 links

Parameter

Type

Description

self

String

Resource link.

previous

String

Previous resource link.

next

String

Next resource link.

Example Request

GET https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers

Example Response

Status code: 200

The request is successful.

{
    "links": {
        "self": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers",
        "previous": null,
        "next": null
    },
    "identity_providers": [
        {
            "remote_ids": [],
            "enabled": true,
            "id": "ACME",
            "sso_type": "iam_user_sso",
            "links": {
                "self": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME",
                "protocols": "https://iam.myhuaweicloud.com/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