Usage permissions
- Print
- PDF
Usage permissions
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Description
Checks the access permission for an employee of customer connected to the partner company.
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 more than 5 minutes, 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 |
Employee Permission Search API
Checks the access permission of an employee.
Request URL
GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/{partnerId}/company/{companyId}/auth/{userId}
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 customer to be searched Developers > Basic settings > Linkage key |
| userId | String | 100 | Y | WORKPLACE empId or loginId |
Request examples
GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/partnertestid/company/1663a976-32c9-48a4-8edb-f1ffcefb1bf3/auth/testuser@sample.com
GET /partner/apigw/v2/partner/partnertestid/company/1663a976-32c9-48a4-8edb-f1ffcefb1bf3/auth/testuser@sample.com
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
Response
Returned as an HTTP status code.
| HTTP status code | Response message | Description |
|---|---|---|
| 200 | OK | Indicates that permission exists |
| 400 | Bad Request | Used for failed general request |
| 401 | Unauthorized | No permission |
| 500 | Internal Server Error | - Response code to general server errors While 4XX error codes represent client-side errors, 5XX error codes represent server-side errors. |
Was this article helpful?