Viewing user information

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:

Name	Type	Description	Required
x-prism-access-token	String	Access Token issued through OAuth2.0 authorization	Y

Responses

This is a description of the response format.

Note

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

Name	Type	Description	Required
userId	String	Value for user classification in the B2B PRISM Live Studio Does not need to match the ID used in the service	Y
userName	String	User name to be exposed in the B2B PRISM Live Studio Forwards userId if it doesn't exist	Y
profileThumbnail	String	Profile thumbnail address	N

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
        }
    }
}