Updating a Protocol
Function
This API is provided for the administrator to update the protocol associated with a specified identity provider.
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
PATCH /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
idp_id |
Yes |
String |
Identity provider name. |
protocol_id |
Yes |
String |
ID of the protocol to be updated |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Yes |
Object |
Protocol information. |
Response Parameters
Parameter |
Type |
Description |
---|---|---|
Object |
Protocol information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Protocol ID |
mapping_id |
String |
Mapping ID. |
Object |
Protocol resource link information. |
Parameter |
Type |
Description |
---|---|---|
identity_provider |
String |
Identity provider resource link. |
self |
String |
Resource link. |
Example Request
Request for updating a protocol
PATCH https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
{ "protocol": { "mapping_id": "ACME" } }
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. |
409 |
A resource conflict occurs. |
413 |
The request entity is too large. |
500 |
Internal server error. |
503 |
Service unavailable. |
Error Codes
None
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot