マネージドポリシーリストの照会
- 印刷する
- PDF
マネージドポリシーリストの照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
Permission Setに追加可能なマネージドポリシー(System Managed)リストを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /api/v1/permission-sets/policies |
リクエストヘッダ
Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
searchWord | String | Optional | 検索キーワード
|
searchColumn | String | Conditional | 検索カラム
|
page | Integer | Optional | ページ番号
|
size | Integer | Optional | ページの出力数
|
リクエスト例
リクエストのサンプルコードは次の通りです。
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}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
page | Number | - | ページ番号 |
totalPages | Number | - | ページの総数 |
totalItems | Number | - | レスポンス結果数 |
isFirst | Boolean | - | 最初のページかどうか
|
isLast | Boolean | - | 最後のページかどうか
|
hasPrevious | Boolean | - | 以前のページは存在するかどうか
|
hasNext | Boolean | - | 次のページは存在するかどうか
|
items | Array | - | ポリシーリスト |
items
items
の説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
policyId | String | - | ポリシー ID |
policyName | String | - | ポリシー名 |
policyDescription | String | - | ポリシーの説明 |
policyCreatedAt | String | - | マネージドポリシー(System Managed)の作成日時
|
レスポンスステータスコード
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"
}
]
}
この記事は役に立ちましたか?