更新时间:2022-08-16 GMT+08:00

注册协议

功能介绍

该接口用于注册一个协议,就是将规则关联到某一身份提供商。

URI

  • URI格式

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

  • 参数说明

    参数

    是否必选

    类型

    说明

    idp_id

    String

    身份提供商的ID。

    protocol _id

    String

    Protocol的ID。

请求

  • Request Header参数说明

    参数

    是否必选

    类型

    说明

    Content-Type

    String

    该字段内容填为“application/json;charset=utf8”

    X-Auth-Token

    String

    已认证的拥有Security Administrator权限的token。

  • Request Body参数说明

    参数

    是否必选

    类型

    说明

    mapping_id

    String

    映射的ID。

  • 请求样例
    curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X PUT -d'{"protocol":{"mapping_id":"ACME"}}' https://sample.domain.com/v3/OS-FEDERATION/identity_providers/ACME/protocols/saml

响应

  • Response Body参数说明

    参数

    是否必选

    类型

    说明

    id

    String

    Protocol的ID。

    mapping_id

    String

    映射的ID。

    links

    Object

    Protocol的资源链接。

  • 响应样例
    {
        "protocol": {
            "id": "saml",
            "links": {
                "identity_provider": "https://example.com/v3/OS-FEDERATION/identity_providers/ACME",
                "self": "https://example.com/v3/OS-FEDERATION/identity_providers/ACME/protocols/saml"
            },
            "mapping_id": "ACME"
        }
    }

状态码

状态码

说明

201

请求成功。

400

请求错误。

401

认证失败。

403

鉴权失败。

404

找不到资源。

405

不允许的方法。

413

请求体过大。

500

内部服务错误。

503

服务不可用。