ユーザー情報の照会

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

ユーザー情報を照会する APIです。B2B PRISM Live Studioでの使用フローを確認するには、ログインプロセスをご参照ください。

リクエスト

リクエスト形式は次の通りです。

GET {serviceApiDomain}/prism/v1/service/user

リクエストヘッダ

ヘッダの説明は次の通りです。

名前	タイプ	説明	必須有無
x-prism-access-token	String	OAuth2.0認証により発行した Access Token	Y

レスポンス

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

参考

デフォルトのレスポンス形式は APIレスポンスのデフォルト形式をご参照ください。

名前	タイプ	説明	必須有無
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
        }
    }
}