Querying Protocol Details
Function
This API is used to query the details of a protocol.
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/{idp_id}/protocols/{protocol_id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| idp_id | Yes | String | Identity provider ID. |
| protocol_id | Yes | String | ID of the protocol to be queried |
Request Parameters
| 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
| Parameter | Type | Description |
|---|---|---|
| Object | Protocol information. |
Example Request
GET https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id} Example Response
Status code: 200
The request is successful.
{
"protocol": {
"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. |
Error Codes
None
Last Article: Listing Protocols
Next Article: Registering a Protocol
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.