--- title: "ユーザー情報の照会" slug: "b2bpls-user" updated: 2026-09-17T09:58:08Z published: 2026-09-17T09:58:08Z canonical: "api.ncloud-docs.com/b2bpls-user" --- > ## Documentation Index > Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # ユーザー情報の照会 Classic/VPC環境で利用できます。 ユーザー情報を照会する APIです。B2B PRISM Live Studioでの使用フローを確認するには、[ログインプロセス](https://guide.ncloud-docs.com/docs/ja/b2bpls-login)をご参照ください。 ## リクエスト リクエスト形式は次の通りです。 ``` GET {serviceApiDomain}/prism/v1/service/user ``` ### リクエストヘッダ ヘッダの説明は次の通りです。 | 名前 | タイプ | 説明 | 必須の有無 | | --- | --- | --- | --- | | x-prism-access-token | String | OAuth 2.0認証を通じて発行した Access Token | Y | ## レスポンス レスポンス形式を説明します。 参考 レスポンスの基本形式は、[APIレスポンスの基本形式](/docs/ja/b2bpls-overview#%EA%B8%B0%EB%B3%B8%EC%9D%91%EB%8B%B5%ED%98%95%EC%8B%9D)をご参照ください。 | 名前 | タイプ | 説明 | 必須の有無 | | --- | --- | --- | --- | | user | Object | userオブジェクト | Y | ### user dto user dtoの説明は次の通りです。 | 名前 | タイプ | 説明 | 必須の有無 | | --- | --- | --- | --- | | userId | String | - B2B PRISM Live Studioでユーザーを識別するための値 - サービスで使用している IDと一致していなくても問題ない | Y | | userName | String | - B2B PRISM Live Studioで表示されるユーザー名 - 存在しない場合、userIdで渡す | Y | | profileThumbnail | String | プロファイルのサムネイルアドレス | N | ## 例 構文の例を紹介します。 ### Access Tokenの発行時 Access Tokenの発行に関する構文例を紹介します。 #### リクエスト例 構文のサンプルコードは次の通りです。 ``` curl -X GET {serviceApiDomain}/prism/v1/service/user -H "x-prism-access-token: {access-token}" ``` #### レスポンス例 構文のサンプルコードは次の通りです。 ``` { "success": true, "errorCode": 0, "errorName": null, "message": null, "data": { "user": { "userId": "admin", "userName": "管理者", "profileThumbnail": null } } } ```