Viewing user information
    • PDF

    Viewing user information

    • PDF

    Article summary

    Available in Classic and VPC

    It is an API to view user information. For the use flow of B2B PRISM Live Studio, see Login process.

    Requests

    The request format is as follows:

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

    Request headers

    The description of the header is as follows:

    NameTypeDescriptionRequired
    x-prism-access-tokenStringAccess Token issued through OAuth2.0 authorizationY

    Responses

    This is a description of the response format.

    Note

    For the basic response format, see the Basic format for API responses.

    NameTypeDescriptionRequired
    userIdString
  • Value for user classification in the B2B PRISM Live Studio
  • Does not need to match the ID used in the service
  • Y
    userNameString
  • User name to be exposed in the B2B PRISM Live Studio
  • Forwards userId if it doesn't exist
  • Y
    profileThumbnailStringProfile thumbnail addressN

    Examples

    Introduces examples of syntax.

    When issuing Access Token

    Introduces examples of syntax for issuing Access Token.

    Request examples

    An example of the syntax is as follows:

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

    Response examples

    An example of the syntax is as follows:

    {
        "success": true,
        "errorCode": 0,
        "errorName": null,
        "message": null,
        "data": {
            "user": {
                "userId": "admin",
                "userName": "Admin",
                "profileThumbnail": null
            }
        }
    }
    

    Was this article helpful?

    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.