사용권한자 조회

인쇄
공유
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

설명

해당 업무지원서비스를 사용할 수 있는 권한자를 조회한다.

요청 헤더 공통

Header	Description
x-ncp-apigw-timestamp	- 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것 - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
x-ncp-iam-access-key	- 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID
x-ncp-apigw-signature-v2	- 위 예제의 Body를 Access Key ID와 맵핑되는 Secret Key로 암호화한 서명 - HMAC 암호화 알고리즘은 HmacSHA256 사용

사용권한자 조회 API

사용권한자 리스트를 조회한다.

요청 URL

GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/{partnerId}/company/{companyId}/auth

요청 Path 파라미터

파라미터	타입	크기	필수 여부	설명
partnerId	String	15	Y	WORKPLACE에서 제공한 파트너 ID
companyId	String	36	Y	조회할 고객사의 연동키(CompanyId) Developers > 기본 설정 > 연동키

요청 예시

GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/partnertestid/company/1663a976-32c9-48a4-8edb-f1ffcefb1bf3/auth

GET /partner/apigw/v2/partner/partnertestid/company/1663a976-32c9-48a4-8edb-f1ffcefb1bf3/auth
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

응답 예시

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2020 01:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34
[
    {
        "tenantId": "c1798784-9a47-4751-ab9f-b9629825ab93",
        "companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
        "empId": "7764286e-5d40-43e7-bff0-4a947e1437e1",
        "externalKey": "apiTestExternal1",
        "name": "홍길동",
        "deptNo": "8d96f825-5b23-4e56-837b-5fc7c5b8aadd",
        "deptName": "테스트부서2",
        "loginId" : "gildong@sample.co.kr",
        "emailAddress" : "gildong@test.com",
        "cellphoneNo" : "0310000000",
        "empStatus" : "IN",
        "type": "EMP"
    }
]

응답 데이터

파라미터	타입	크기	필수	설명
tenantId	String	36	Y	그룹사 코드, 그룹사별 고유키
companyId	String	36	Y	회사 코드, 회사별 고유키
empId	String	36	Y	사원 코드, 사원별 고유키
externalKey	String	100	N	외부 매핑 키
name	String	100	Y	사원 이름
deptNo	String	36	Y	소속 부서 코드
deptName	String	100	Y	부서 이름
loginId	String	500	Y	로그인 아이디
emailAddress	String	500	Y	이메일
cellphoneNo	String	100	N	휴대폰
empStatus	String	10	Y	재직 상태(재직 : IN, 휴직 : REST, 퇴직 : RETIRE, 삭제 : DELETE)
type	String	4	Y	구분(EMP, DEPT)

응답

HTTP 상태 코드로 반환한다.

HTTP 상태 코드	응답 메시지	설명
200	OK	권한 있음
400	Bad Request	일반적인 요청 실패에 사용
401	Unauthorized	권한없음
500	Internal Server Error	- 일반적인 서버 오류에 대한 응답 코드 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용 - 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용

이 문서가 도움이 되었습니까?

What's Next

서비스 개설 완료

설명
요청 헤더 공통
사용권한자 조회 API
응답 데이터
응답

태그

WORKPLACE