Permission Lookup
- Print
- PDF
Permission Lookup
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Description
View the permission owners who can use the business support service.
Request header common
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | - This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. - If the time difference compared to the API Gateway server is 5 minutes or more, then the request is considered invalid. |
| x-ncp-iam-access-key | - Access key ID issued on the NAVER Cloud Platform portal or by Sub Account |
| x-ncp-apigw-signature-v2 | - A signature that encrypts the body of the example above with the secret key mapped to the access key ID - Uses HmacSHA256 for the HMAC encryption algorithm |
Permission owner query API
View the list of permission owners.
Request URL
GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/{partnerId}/company/{companyId}/auth
Request path parameter
| Parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| partnerId | String | 15 | Y | Partner ID provided by WORKPLACE |
| companyId | String | 36 | Y | Linkage key (CompanyId) of the customer to view Developers > Basic Settings > Linkage Key |
Request examples
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=
Response examples
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": "Gildong Hong",
"deptNo": "8d96f825-5b23-4e56-837b-5fc7c5b8aadd",
"deptName": "Test department 2",
"loginId" : "gildong@sample.co.kr",
"emailAddress" : "gildong@test.com",
"cellphoneNo" : "0310000000",
"empStatus" : "IN",
"type": "EMP"
}
]
Response data
| Parameter | Type | Size | Required | Description |
|---|---|---|---|---|
| tenantId | String | 36 | Y | Corporate group code, unique key for the corporate group |
| companyId | String | 36 | Y | Company code, unique key for the company |
| empId | String | 36 | Y | Employee code, unique key for the employee |
| externalKey | String | 100 | N | External mapping key |
| name | String | 100 | Y | Employee name |
| deptNo | String | 36 | Y | Department code |
| deptName | String | 100 | Y | Department name |
| loginId | String | 500 | Y | Login ID |
| emailAddress | String | 500 | Y | |
| cellphoneNo | String | 100 | N | Mobile phone |
| empStatus | String | 10 | Y | Employment status (employed: IN, on leave: REST, retired: RETIRE, deleted: DELETE) |
| type | String | 4 | Y | Type (EMP, DEPT) |
Responses
Returned as an HTTP status code.
| HTTP status code | Response message | Description |
|---|---|---|
| 200 | OK | Has the permission |
| 400 | Bad Request | Used for failed general request |
| 401 | Unauthorized | No permission |
| 500 | Internal Server Error | - Response code for general server errors While 4XX error codes represent client-side errors, - 5XX error codes represent server-side errors. |
Was this article helpful?