アクセス許可の検索
- 印刷する
- PDF
アクセス許可の検索
- 印刷する
- 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 | - NAVERクラウドプラットフォームポータルまたは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
リクエストパスパラメータ
| パラメータ | タイプ | サイズ | 必須確認 | 説明 |
|---|---|---|---|---|
| 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 | ログインID |
| 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番台のエラーコードはサーバ側のエラーを表示するために使用 |
この記事は役に立ちましたか?