代表管理者照会
- 印刷する
- 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 | * NAVERクラウドプラットフォームポータルまたは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代のエラーコードはサーバ側のエラーを表示するために使われます。 |
この記事は役に立ちましたか?