Querying an Identity Provider

Function

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

URI

• URI format

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

• URI parameters

  Parameter	Mandatory	Type	Description
  id	Yes	String	ID of an identity provider.

Request Parameters

• 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	Authenticated token.

• Example request

  curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X GET https://sample.domain.com/v3/OS-FEDERATION/identity_providers/ACME

Response Parameters

• Parameters in the response body

  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	Identity provider resource link.

• Example response

  {
      "identity_provider": {
          "description": "Stores ACME identities",
          "enabled": false,
          "id": "ACME",
          
          "remote_ids": [],
          "links": {
              "protocols": "https://sample.domain.com/v3/OS-FEDERATION/identity_providers/ACME/protocols",
              "self": "https://sample.domain.com/v3/OS-FEDERATION/identity_providers/ACME"
          }
      }
  }

Status Codes