リクエスト

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

メソッド	URI
GET	/api/v1/profiles

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`searchColumn`	String	Optional	検索カラム `name` \| `profileNrn` `name`: Profile名 `profileNrn`: Profileに対する NAVERクラウドプラットフォームリソースの識別値
`searchWord`	String	Optional	検索キーワード
`page`	Integer	Optional	ページ番号 0~N (デフォルト: 0)
`size`	Integer	Optional	ページの出力数 1~N (デフォルト: 20)

リクエスト例

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

curl --location --request GET 'https://externalaccess.apigw.ntruss.com/api/v1/profiles' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	-	ページ番号
`totalElements`	Integer	-	レスポンス結果数
`pageSize`	Integer	-	ページ表示数
`content`	Array	-	Profileリスト

`content`

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

フィールド	タイプ	必須の有無	説明
`profileId`	String	-	Profile ID
`profileNrn`	String	-	Profileに対する NAVERクラウドプラットフォームリソースの識別値
`name`	String	-	Profile名
`description`	String	-	Profileの説明
`enabled`	Boolean	-	状態 `true` \| `false` `true`: 有効化 `false`: 無効化
`durationSeconds`	Integer	-	セッションの有効期限仮認証情報の持続時間(秒)
`roleNrnList`	Array	-	Profileにマッピングされたロールリスト
`createTime`	String	-	作成日時 ISO 8601形式
`updateTime`	String	-	最終更新日時 ISO 8601形式

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

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

レスポンス例

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

{
    "pageNo": 0,
    "totalElements": 1,
    "pageSize": 20,
    "content": [
        {
            "profileId": "76da1a8c-****-****-****-cf13dfc49aa6",
            "profileNrn": "nrn:PUB:ExternalAccess::*******:Profile/76da1a8c-****-****-****-cf13dfc49aa6",
            "name": "profile000",
            "description": "profile",
            "enabled": true,
            "durationSeconds": 600,
            "roleNrnList": [],
            "createTime": "2024-12-13T14:24:45.128+09:00",
            "updateTime": "2024-12-13T14:24:45.128+09:00"
        }
    ]
}

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

リクエスト
レスポンス