マネージドポリシーリストの照会
    • PDF

    マネージドポリシーリストの照会

    • PDF

    記事の要約

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

    Permission Setに追加可能なマネージドポリシー(System Managed)リストを照会します。

    リクエスト

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

    メソッドURI
    GET/api/v1/permission-sets/policies

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    searchWordStringOptional検索キーワード
    • policyNameと全体または一部が一致しない値を入力した場合、レスポンス時にitemsは空の値の[]で表示
    searchColumnStringConditional検索カラム
    • policyName: ポリシー名 (有効値)
      • <例> searchColumn=policyName
    • 有効でない値を入力した場合、全リストを表示
    pageIntegerOptionalページ番号
    • 0~N (デフォルト: 0)
    sizeIntegerOptionalページの出力数
    • 1~N (デフォルト: 20)

    リクエスト例

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

    curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/permission-sets/policies?searchColumn=policyName&searchWord=NCLOUD_SINGLE_SIGN_ON&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-ポリシーリスト

    items

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

    フィールドタイプ必須の有無説明
    policyIdString-ポリシー ID
    policyNameString-ポリシー名
    policyDescriptionString-ポリシーの説明
    policyCreatedAtString-マネージドポリシー(System Managed)の作成日時
    • ISO 8601形式

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

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

    レスポンス例

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

    {
        "page": 0,
        "totalPages": 14,
        "totalItems": 262,
        "isFirst": true,
        "isLast": false,
        "hasPrevious": false,
        "hasNext": true,
        "items": [
            {
                "policyId": "08705730-****-****-****-246e96591a38",
                "policyName": "NCP_NCLOUD_SINGLE_SIGN_ON_VIEWER",
                "policyDescription": "Permission to only view items and their details in Ncloud Single Sign-On",
                "policyCreatedAt": "2022-07-21T10:29:42Z"
            },
            {
                "policyId": "0861ff50-****-****-****-246e96591a38",
                "policyName": "NCP_NCLOUD_SINGLE_SIGN_ON_MANAGER",
                "policyDescription": "Permission to use all the features in Ncloud Single Sign-On",
                "policyCreatedAt": "2022-07-21T10:29:42Z"
            }
        ]
    }
    

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

    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.