Subjectリストの照会

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

Subjectリストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`searchColumn`	String	Optional	検索カラム `subjectId` \| `subjectNrn` `subjectId`: Subject ID `subjectNrn`: Subjectに対する 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/subjects?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}' \
--header 'Accept: application/json'

レスポンス

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

レスポンスボディ

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

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

`content`

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

フィールド	タイプ	必須の有無	説明
`subjectId`	String	-	Subject ID
`subjectNrn`	String	-	Subjectに対する NAVERクラウドプラットフォームリソースの識別値
`x509Subject`	String	-	証明書の X.509 Subject識別子
`enabled`	Boolean	-	状態 `true` \| `false` `true`: 有効化 `false`: 無効化
`createTime`	String	-	作成日時 ISO 8601形式
`updateTime`	String	-	最終更新日時 ISO 8601形式
`lastSeenTime`	String	-	最終使用日時 ISO 8601形式

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

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

レスポンス例

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

{
    "pageNo": 0,
    "totalElements": 3,
    "pageSize": 20,
    "content": [
        {
            "subjectId": "c2dea79b-****-****-****-c162618da17d",
            "subjectNrn": "nrn:PUB:ExternalAccess::******:Subject/c2dea79b-****-****-****-c162618da17d",
            "x509Subject": "CN=Real End cert simsiss, OU=IAM, O=Naver cloud, L=B, ST=A, C=KR",
            "enabled": true,
            "createTime": "2024-11-21T17:47:06.293+09:00",
            "updateTime": "2024-12-12T18:09:05.7+09:00",
            "lastSeenTime": "2024-12-12T18:09:05.699+09:00"
        },
        {
            "subjectId": "c6c0bbdb-****-****-****-835d16999c7b",
            "subjectNrn": "nrn:PUB:ExternalAccess::******:Subject/c6c0bbdb-****-****-****-835d16999c7b",
            "x509Subject": "CN=End Cert simsiss, OU=IAM Service, O=NAVER Cloud Corp., L=Seongnam-si, ST=Gyeonggi-do, C=KR",
            "enabled": true,
            "createTime": "2024-10-17T19:38:35.591+09:00",
            "updateTime": "2024-10-18T10:22:00.547+09:00",
            "lastSeenTime": "2024-10-18T10:22:00.546+09:00"
        },
        {
            "subjectId": "6812e8d3-****-****-****-85bab3480238",
            "subjectNrn": "nrn:PUB:ExternalAccess::******:Subject/6812e8d3-****-****-****-85bab3480238",
            "x509Subject": "CN=Mid - EndCert, OU=IAM Service, O=NAVER Cloud Corp., L=Seongnam-si, ST=Gyeonggi-do, C=KR",
            "enabled": true,
            "createTime": "2024-10-17T19:47:14.771+09:00",
            "updateTime": "2024-10-17T19:47:14.771+09:00",
            "lastSeenTime": "2024-10-17T19:47:14.739+09:00"
        }
    ]
}