Listing Protocols

Function

This API is used to list all protocols.

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

Debugging

You can debug this API in API Explorer.

URI

GET /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
idp_id	Yes	String	Identity provider ID.

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	Access token issued to a user to bear its identity and permissions. For details about the permissions required by the token, see Actions.

Response Parameters

**Table 3** Parameters in the response body
Parameter	Type	Description
links	Object	Resource link information.
protocols	Array of objects	Protocol information.

**Table 4** links
Parameter	Type	Description
self	String	Resource link.
previous	String	Previous resource link. If the previous resource link is unavailable, this parameter is set to null.
next	String	Next resource link. If the next resource link is unavailable, this parameter is set to null.

**Table 5** protocols
Parameter	Type	Description
id	String	Protocol ID.
mapping_id	String	Mapping ID.
links	Object	Protocol resource link information.

**Table 6** protocols.links
Parameter	Type	Description
identity_provider	String	Identity provider resource link.
self	String	Resource link.

Example Request

Request for querying protocols

GET https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/{idp_id}/protocols

Example Response

Status code: 200

The request is successful.

{
    "links": {
        "self": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/protocols",
        "previous": null,
        "next": null
    },
    "protocols": [
        {
            "mapping_id": "ACME",
            "id": "saml",
            "links": {
                "self": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME/protocols/saml",
                "identity_provider": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME"
            }
        }
    ]
}

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.