Modifying a SAML Identity Provider
Function
This API is provided for the administrator to modify a SAML 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/{id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
Yes |
String |
ID of the identity provider to be updated. |
Request Parameters
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Yes |
Object |
Identity provider information. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
description |
No |
String |
Description of the identity provider. |
enabled |
No |
Boolean |
Enabling status of the identity provider. true indicates that the identity provider is enabled. false indicates that the identity provider is disabled. The default value is false. |
Response Parameters
Parameter |
Type |
Description |
---|---|---|
Object |
Identity provider information. |
Parameter |
Type |
Description |
---|---|---|
sso_type |
String |
Identity provider type. |
id |
String |
Identity provider ID. |
description |
String |
Description of the identity provider. |
enabled |
Boolean |
Enabling status of the identity provider. true indicates that the identity provider is enabled. false indicates that the identity provider is disabled. The default value is false. |
remote_ids |
Array of strings |
List of federated user IDs configured for the identity provider. |
Object |
Identity provider resource link. |
Parameter |
Type |
Description |
---|---|---|
self |
String |
Identity provider resource link. |
protocols |
String |
Protocol resource link. |
Example Request
Request for disabling the SAML identity provider
PATCH https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/{id}
{ "identity_provider": { "description": "Stores ACME identities.", "enabled": false } }
Example Response
Status code: 200
The request is successful.
{ "identity_provider": { "remote_ids": [], "enabled": false, "id": "ACME", "sso_type": "iam_user_sso", "links": { "self": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME", "protocols": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME/protocols" }, "description": "Stores ACME identities." } }
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