IP ACLの Assignmentリストの照会
    • PDF

    IP ACLの Assignmentリストの照会

    • PDF

    記事の要約

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

    IP ACLに追加した Assignmentリストを照会します。

    リクエスト

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

    メソッドURI
    GET/api/v1/ip-acls/{ipAclId}/assignments

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    ipAclIdStringRequiredIP ACL ID

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

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

    フィールドタイプ必須の有無説明
    targetTypeStringRequiredターゲットのタイプ
    • console | api
      • console: コンソールにアクセス
      • api: API Gatewayにアクセス
    pageIntegerOptionalページ番号
    • 0~N (デフォルト: 0)
    sizeIntegerOptionalページの出力数
    • 1~N (デフォルト: 20)

    リクエスト例

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

    curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/ip-acls/5bf4cad0-****-****-****-cd51bba3fe23/assignments?targetType=console&page=0&size=20' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    pageNumber-ページ番号
    totalPagesNumber-ページの総数
    totalItemsNumber-レスポンス結果数
    isFirstBoolean-最初のページかどうか
    • true | false
      • true: 最初のページ
      • false: 最初のページではない
    isLastBoolean-最後のページかどうか
    • true | false
      • true: 最後のページ
      • false: 最後のページではない
    hasPreviousBoolean-以前のページは存在するかどうか
    • true | false
      • true: 存在する
      • false: 存在しない
    hasNextBoolean-次のページは存在するかどうか
    • true | false
      • true: 存在する
      • false: 存在しない
    itemsArray-Assignmentリスト

    items

    itemsの説明は次の通りです。

    フィールドタイプ必須の有無説明
    assignmentIdString-Assignment ID
    assignmentNameString-Assignment名
    descriptionString-Assignmentの説明
    nrnString-Assignmentに対する NAVERクラウドプラットフォームリソースの識別値
    statusString-Assignmentの状態
    • active | suspended
      • active: 有効化
      • suspended: 無効化
    iamRoleNrnString-Sub Accountサービスに作成された SSOロールの NRN
    • IAM roleに対する NAVERクラウドプラットフォームリソースの識別値
    consoleAccessAllowedBoolean-コンソールアクセスを許可するかどうか
    • true | false
      • true: 許可
      • false: 許可しない
    consoleAccessRestrictedBoolean-コンソールアクセスを制限するかどうか
    • true | false
      • true: 制限
      • false: 制限しない
    apiAccessAllowedBoolean-API Gatewayアクセスを許可するかどうか
    • true | false
      • true: 許可
      • false: 許可しない
    apiAccessRestrictedBoolean-API Gatewayアクセスを制限するかどうか
    • true | false
      • true: 制限
      • false: 制限しない
    createdAtString-Assignmentの作成日時
    • ISO 8601形式
    updatedAtString-Assignmentの最終更新日時
    • ISO 8601形式
    accountMbrNoInteger-アカウントの会員番号(MemberNo)
    accountNameString-アカウントのユーザー名
    permissionCreatedAtString-Permission Setの作成日時
    • ISO 8601形式

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

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

    レスポンス例

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

    {
        "page" : 0,
        "totalPages" : 1,
        "totalItems" : 1,
        "isFirst" : true,
        "isLast" : true,
        "hasPrevious" : false,
        "hasNext" : false,
        "items" : [
            {
                "assignmentId" : "e1653f17-****-****-****-deb664fb8a2f",
                "assignmentName" : "assignment000",
                "description" : "assignment000",
                "nrn" : "nrn:PUB:SSO::*******:Assignment/e1653f17-****-****-****-deb664fb8a2f",
                "status" : "active",
                "iamRoleNrn" : "nrn:PUB:IAM::*******:Role/385550d0-****-****-****-005056a79baa",
                "consoleAccessAllowed" : true,
                "consoleAccessRestricted" : true,
                "apiAccessAllowed" : true,
                "apiAccessRestricted" : true,
                "createdAt" : "2025-01-13T02:36:40Z",
                "updatedAt" : "2025-01-13T06:46:34Z",
                "accountMbrNo" : *******,
                "accountName" : "田中太郎",
                "permissionSetId" : "3fcd3c17-****-****-****-2a594248bf28"
            }
        ]
    }
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.