대표관리자조회
- 인쇄
- PDF
대표관리자조회
- 인쇄
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
설명
고객사의 WOKPLACE 대표관리자를 조회하기 위한 API입니다.
대표관리자여부 사원별 조회 API
사원별 대표관리자여부를 조회한다.
요청 URL
GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/auth/{externalKey}
요청 헤더
| 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 사용 |
요청 Path 파라미터
| 파라미터 | 타입 | 크기 | 필수 여부 | 설명 |
|---|---|---|---|---|
| companyId | String | 36 | Y | 연동키(CompanyId) Developers > 기본 설정 > 연동키 |
| externalKey | String | 36 | Y | 추가정보 외부키 |
요청 예시
GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/auth/759d67ab-bdca-406a-9cf0-834e0288bf4f
응답 예시
{
"timestamp": "2019-12-13 16:04:07",
"status": 200,
"error": null,
"message": null,
"path": "/organization/apigw/v1/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/auth/759d67ab-bdca-406a-9cf0-834e0288bf4f",
"body": {
"companyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
"externalKey": "759d67ab-bdca-406a-9cf0-834e0288bf4f",
"reprYn": "Y"
}
}
응답
HTTP 상태 코드로 리턴되고 Body 정보로 전달한다.
| HTTP 상태 코드 | 응답 메시지 | 설명 |
|---|---|---|
| 200 | OK | 일반적인 요청 성공 |
| 201 | Created | 리소스 생성 성공에 대한 응답 코드 |
| 400 | Bad Request | 일반적인 요청 실패에 사용(대체로 서버가 이해할 수 없는 형식의 요청이 왔을 때 응답하기 위해 사용) |
| 500 | Internal Server Error | - 일반적인 서버 오류에 대한 응답 코드 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용 - 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용 |
이 문서가 도움이 되었습니까?