Available in Classic and VPC
This API retrieves user information. To view the usage flow in B2B PRISM Live Studio, see Login process.
Request
The method and URI are as follows:
GET {serviceApiDomain}/prism/v1/service/user
Request headers
The following describes the headers.
| Name | Type | Description | Required |
|---|---|---|---|
| x-prism-access-token | String | Access token issued via OAuth 2.0 authorization | Y |
Response
This section describes the response format.
Note
For the default response format, see API response default format.
| Name | Type | Description | Required |
|---|---|---|---|
| user | Object | User object | Y |
user dto
The following describes the user dto.
| Name | Type | Description | Required |
|---|---|---|---|
| userId | String |
|
Y |
| userName | String |
|
Y |
| profileThumbnail | String | Profile thumbnail address | N |
Examples
Here are some example syntaxes.
When issuing access token
The following are examples of the syntax for issuing an access token.
Request example
The following is a sample syntax.
curl -X GET {serviceApiDomain}/prism/v1/service/user
-H "x-prism-access-token: {access-token}"
Response example
The following is a sample syntax.
{
"success": true,
"errorCode": 0,
"errorName": null,
"message": null,
"data": {
"user": {
"userId": "admin",
"userName": "Administrator",
"profileThumbnail": null
}
}
}