SSO Userリストの照会

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

SSO Userリストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`searchColumn`	String	Conditional	検索カラム `loginId` \| `status` \| `nrn` \| `userId` `loginId`: SSO Userログイン ID `status`: SSO Userの状態 `nrn`: SSO Userに対する NAVERクラウドプラットフォームリソースの識別値 `userId`: SSO User ID
`searchWord`	String	Optional	検索キーワード `searchColumn`に`status`を入力すると`active`(使用中、有効化)または`suspended`(停止、無効化)で検索可能検索カラムのオプション(`loginId`、`status`、`nrn`、`userId`)と全体または一部が一致しない値を入力した場合、レスポンス時に`items`は空の値の`[]`で表示 `searchColumn`なしでリクエストする場合、全リストを表示
`page`	Integer	Optional	ページ番号 0~N (デフォルト: 0)
`size`	Integer	Optional	ページの出力数 1~N (デフォルト: 20)

リクエスト例

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

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/users?searchColumn=status&searchWord=active&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	-	最初のページかどうか `true` \| `false` `true`: 最初のページ `false`: 最初のページではない
`isLast`	Boolean	-	最後のページかどうか `true` \| `false` `true`: 最後のページ `false`: 最後のページではない
`hasPrevious`	Boolean	-	以前のページは存在するかどうか `true` \| `false` `true`: 存在する `false`: 存在しない
`hasNext`	Boolean	-	次のページは存在するかどうか `true` \| `false` `true`: 存在する `false`: 存在しない
`items`	Array	-	Userリスト

`items`

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

フィールド	タイプ	必須の有無	説明
`userId`	String	-	SSO User ID
`loginId`	String	-	SSO Userログイン ID
`nrn`	String	-	SSO Userに対する NAVERクラウドプラットフォームリソースの識別値
`userProfile`	Object	-	SSO User Profile情報
`userProfile.firstName`	String	-	SSO Userの名(下の名前)
`userProfile.lastName`	String	-	SSO Userの姓(苗字)
`userProfile.email`	String	-	SSO Userのメールアドレス
`userProfile.emailVerified`	Boolean	-	メールアドレスは認証済みかどうか `true` \| `false` `true`: 認証完了 `false`: 認証が必要
`userProfile.empNo`	String	-	SSO Userの社員番号
`userProfile.phoneCountryCode`	String	-	SSO Userの国番号
`userProfile.phoneNo`	String	-	SSO Userの携帯電話番号
`userProfile.phoneNoVerified`	Boolean	-	携帯電話番号は認証済みかどうか `true` \| `false` `true`: 認証完了 `false`: 認証が必要
`userProfile.deptName`	String	-	SSO Userの部署名
`accessRules`	Object	-	アクセスルール情報
`accessRules.consoleAccessAllowed`	Boolean	-	コンソールアクセスを許可するかどうか `true` \| `false` `true`: 許可 `false`: 許可しない
`accessRules.apiAccessAllowed`	Boolean	-	API Gatewayアクセスを許可するかどうか `true` \| `false` `true`: 許可 `false`: 許可しない
`status`	String	-	SSO Userの状態 `active` \| `suspended` `active`: 使用中(有効化) `suspended`: 停止(無効化)
`description`	String	-	SSO Userの説明
`lastLoginAt`	String	-	SSO Userの最終アクセス日時 ISO 8601形式
`createdAt`	String	-	SSO Userの作成日時 ISO 8601形式
`updatedAt`	String	-	SSO Userの更新日時 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": [
        {
            "userId": "80d9ba0d-****-****-****-76afe6ea5b33",
            "loginId": "******@ncloud.com",
            "nrn": "nrn:PUB:SSO::*******:User/80d9ba0d-****-****-****-76afe6ea5b33",
            "userProfile": {
                "firstName": "太郎",
                "lastName": "田中",
                "email": "*******@ncloud.com",
                "emailVerified": true,
                "empNo": "00112233",
                "phoneCountryCode": "82",
                "phoneNo": "010-1111-1111",
                "phoneNoVerified": true,
                "deptName": "部署"
            },
            "accessRules": {
                "consoleAccessAllowed": true,
                "apiAccessAllowed": true
            },
            "status": "active",
            "lastLoginAt": "2025-01-06T01:37:11Z",
            "createdAt": "2025-01-03T05:08:42Z",
            "updatedAt": "2025-01-06T01:37:11Z",
            "description": "SSO User"
        }
    ]
}