사용자 정보 조회

Prev Next

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