MENU
      ユーザー情報の照会

        ユーザー情報の照会


        記事の要約

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

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

        リクエスト

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

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

        リクエストヘッダ

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

        名前タイプ説明必須有無
        x-prism-access-tokenStringOAuth2.0認証により発行した Access TokenY

        レスポンス

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

        参考

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

        名前タイプ説明必須有無
        userIdString
      • B2B PRISM Live Studioでユーザーを区別するための値
      • 必ずしもサービスで使用する IDと一致しなくても可能
      • Y
        userNameString
      • B2B PRISM Live Studioで表示されるユーザー名
      • 存在しない場合、userIdで転送
      • Y
        profileThumbnailStringプロファイルサムネイルアドレスN

        構文例を紹介します。

        Access Token発行時

        Access Token発行の構文例を紹介します。

        リクエスト例

        構文例は次の通りです。

        curl -X GET {serviceApiDomain}/prism/v1/service/user
            -H "x-prism-access-token: {access-token}"
        Bash

        レスポンス例

        構文例は次の通りです。

        {
            "success": true,
            "errorCode": 0,
            "errorName": null,
            "message": null,
            "data": {
                "user": {
                    "userId": "admin",
                    "userName": "管理者",
                    "profileThumbnail": null
                }
            }
        }
        JSON

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

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.