Registering a Protocol

Function

This API is provided for the administrator to associate a protocol with an identity provider after creating the 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

PUT /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
idp_id	Yes	String	Identity provider name.
protocol_id	Yes	String	ID of the protocol to be registered The value of this field can be saml or oidc.

Request Parameters

**Table 2** Parameters in the request header
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.

**Table 3** Parameters in the request body
Parameter	Mandatory	Type	Description
protocol	Yes	Object	Protocol information.

**Table 4** protocol
Parameter	Mandatory	Type	Description
mapping_id	No	String	Mapping ID. This parameter is required only if the identity provider type is iam_user_sso.

Response Parameters

**Table 5** Parameters in the response body
Parameter	Type	Description
protocol	Object	Protocol information.

**Table 6** protocol
Parameter	Type	Description
id	String	Protocol ID The value of this field can be saml or oidc.
mapping_id	String	Mapping ID.
links	Object	Protocol resource link information.

**Table 7** protocol.links
Parameter	Type	Description
identity_provider	String	Identity provider resource link.
self	String	Resource link.

Example Request

Request for registering a protocol

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

{
    "protocol": {
        "mapping_id": "ACME"
    }
}

Example Response

Status code: 201

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
201	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.