移動

• リクエスト
• レスポンス

RESTプロキシのカスタム登録の作成

post

/console/admin/api/v2/nodes/restproxies/{restProxyId}/enrollments

RESTプロキシのカスタム登録を作成します。登録により、ユーザーは登録証明書なしでRESTプロキシをコールできます。登録には、認証サーバーに定義される新しいユーザー・グループが必要です。

リクエスト

サポートされるメディア・タイプ

• application/json

パス・パラメータ

• restProxyId(必須): string
  RESTプロキシのID

本文()

カスタム登録の作成

ルート・スキーマ: createCustomEnrollmentBody

型: object

ソースの表示

• attributes: object attributes
  使用可能なその他のプロパティ: additionalProperties

  登録証明書に追加される文字列値属性を持つカスタム・キー
• enrollmentId(必須): string
  登録ID

{
    "type":"object",
    "required":[
        "enrollmentId"
    ],
    "properties":{
        "enrollmentId":{
            "description":"enrollment ID",
            "type":"string"
        },
        "attributes":{
            "description":"Custom keys with string value attributes to be added to the enrollment certificate",
            "type":"object",
            "properties":{
                "username":{
                    "description":"Special attribute to associate the default user for the enrollment",
                    "type":"string"
                }
            },
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "example":{
        "enrollmentId":"my-custom-enrollment",
        "attributes":{
            "username":"[e-mail]",
            "department":"operations",
            "role":"ADMIN"
        }
    }
}

例:

{
    "enrollmentId":"my-custom-enrollment",
    "attributes":{
        "username":"[e-mail]",
        "department":"operations",
        "role":"ADMIN"
    }
}

ネストしたスキーマ: attributes

型: object

使用可能なその他のプロパティ

ソースの表示

• string

{
    "description":"Custom keys with string value attributes to be added to the enrollment certificate",
    "type":"object",
    "properties":{
        "username":{
            "description":"Special attribute to associate the default user for the enrollment",
            "type":"string"
        }
    },
    "additionalProperties":{
        "type":"string"
    }
}

登録証明書に追加される文字列値属性を持つカスタム・キー

ソースの表示

• username: string
  登録のデフォルト・ユーザーを関連付ける特殊属性

{
    "description":"Custom keys with string value attributes to be added to the enrollment certificate",
    "type":"object",
    "properties":{
        "username":{
            "description":"Special attribute to associate the default user for the enrollment",
            "type":"string"
        }
    },
    "additionalProperties":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

成功

本文()

ルート・スキーマ: schema

型: object

400レスポンス

無効な引数

本文()

ルート・スキーマ: 400errorModels

型: object

ソースの表示

• key: string
• value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "respMesg":"invalid argument"
    }
}

例:

{
    "respMesg":"invalid argument"
}

401レスポンス

未認可

403レスポンス

禁止されています

500レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ: 500errorModels

型: object

ソースの表示

• key: string
• value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

デフォルト・レスポンス

予期しないエラー

本文()

ルート・スキーマ: errorModel

型: object

ソースの表示

• code(必須): integer(int32)
• message(必須): string

{
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "type":"string"
        }
    }
}

先頭に戻る