Assignmentに IP ACLを追加

Prev Next

最新のコンテンツが反映されていません。早急にアップデート内容をご提供できるよう努めております。最新のコンテンツ内容は韓国語ページをご参照ください。

Classic/VPC環境で利用できます。

Assignmentに IP ACLを追加します。

参考

1つの Assignmentには最大5つの IP ACLを追加できます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /api/v1/assignments/{assignmentId}/ip-acls

リクエストヘッダ

Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
assignmentId String Required Assignment ID

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
consoleAccessAllowed Boolean Required コンソールアクセスを許可するかどうか
  • true | false
    • true: 許可
    • false: 許可しない
consoleAccessRestricted Boolean Optional コンソールアクセスを制限するかどうか
  • true | false
    • true: 制限
    • false: 制限しない
  • consoleAccessAllowedの設定値と一致することが必要
consoleAccessIpAclIds Array Optional コンソールにアクセス可能な IP ACL IDリスト
apiAccessAllowed Boolean Required API Gatewayアクセスを許可するかどうか
  • true | false
    • true: 許可
    • false: 許可しない
apiAccessRestricted Boolean Optional API Gatewayアクセスを制限するかどうか
  • true | false
    • true: 制限
    • false: 制限しない
  • apiAccessAllowedの設定値と一致することが必要
apiAccessIpAclIds Array Optional API Gatewayにアクセス可能な IP ACL IDリスト

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/assignments/2c15b16c-****-****-****-3e7207ff2bf6/ip-acls' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "consoleAccessAllowed": true,
    "consoleAccessRestricted": true,
    "consoleAccessIpAclIds": [
        "5bf4cad0-****-****-****-cd51bba3fe23"
    ],
    "apiAccessAllowed": true,
    "apiAccessRestricted": true,
    "apiAccessIpAclIds": [
        "5bf4cad0-****-****-****-cd51bba3fe23"
    ]
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
id String - Assignment ID
nrn String - Assignmentに対する NAVERクラウドプラットフォームリソースの識別値
success Boolean - API処理結果
  • true | false
    • true: 成功
    • false: 失敗
message String - 結果メッセージ
  • successがfalseの場合、表示

レスポンスステータスコード

Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Single Sign-Onのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "id": "2c15b16c-****-****-****-3e7207ff2bf6",
    "nrn": "nrn:PUB:SSO::*******:Assignment/2c15b16c-****-****-****-3e7207ff2bf6",
    "success": true
}