• Identity and Access Management

iam
  1. Help Center
  2. Identity and Access Management
  3. API Reference
  4. Federated Identity Authentication Management
  5. Identity Provider
  6. Querying the Identity Provider List

Querying the Identity Provider List

Function Description

This interface is used to query the identity provider list.

URI

URI format

GET /v3/OS-FEDERATION/identity_providers

Request

  • Request header parameter description

    Parameter

    Mandatory

    Type

    Description

    Content-Type

    Yes

    String

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

    X-Auth-Token

    Yes

    String

    Authenticated token.

  • Sample request
    curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X GET https://10.185.190.118:31943/v3/OS-FEDERATION/identity_providers

Response

  • Response body parameter description

    Parameter

    Mandatory

    Type

    Description

    identity_providers

    Yes

    Array

    List of identity providers.

    links

    Yes

    Object

    Resource links of an identity provider.

  • Description for the identity_providers format

    Parameter

    Mandatory

    Type

    Description

    id

    Yes

    String

    ID of an identity provider.

    description

    Yes

    String

    Identity provider description.

    enabled

    Yes

    Boolean

    Whether an identity provider is enabled. true indicates that the identity provider is enabled. false indicates that the identity provider is disabled. The default value is false.

    remote_ids

    Yes

    Array

    Federated user ID list of an identity provider.

    links

    Yes

    Object

    Resource links of an identity provider.

  • Sample response
    {
        "identity_providers": [
            {
                "description": "Stores ACME identities",
                "enabled": true,
                "id": "ACME",
                "remote_ids": [],
                "links": {
                    "protocols": "https://example.com/v3/OS-FEDERATION/identity_providers/ACME/protocols",
                    "self": "https://example.com/v3/OS-FEDERATION/identity_providers/ACME"
                }
            },
            {
                "description": "Stores contractor identities",
                "enabled": false,
                "remote_ids": [],
                "id": "ACME-contractors",
                "links": {
                    "protocols": "https://example.com/v3/OS-FEDERATION/identity_providers/ACME-contractors/protocols",
                    "self": "https://example.com/v3/OS-FEDERATION/identity_providers/ACME-contractors"
                }
            }
        ],
        "links": {
            "next": null,
            "previous": null,
            "self": "https://example.com/v3/OS-FEDERATION/identity_providers"
        }
    }

Status Codes

Status Code

Description

200

The request is successful.

400

The server failed to process the request.

401

You must enter a username and password to access the requested page.

403

You are forbidden to access the requested page.

404

The server could not find the requested page.

405

You are not allowed to use the method specified in the request.

413

The request entity is too large.

500

Failed to complete the request because of an internal service error.

503

Failed to complete the request because the service is unavailable.