リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/{type}/{zone}/getMemberInfo

リクエストヘッダ

Secure Zone APIで共通して使用されるヘッダの詳細は、Secure Zoneのリクエストヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`type`	String	Required	Secure Zoneで提供するファイアウォールタイプ `szfw` \| `psfw` `szfw`: Secure Zone Standard `psfw`: Secure Zone Advanced
`zone`	String	Required	Secure Zoneを構成したゾーン `kr1` \| `kr2` `kr1`: KR-1ゾーン `kr2`: KR-2ゾーン

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`memberNo`	String	Optional	ユーザーの NAVERクラウドプラットフォーム会員番号
`instanceNo`	String	Optional	インスタンス作成時に付与された契約番号

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://securezonefirewall.apigw.ntruss.com/api/v2/szfw/kr2/getMemberInfo'
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-mbr_no: {User number}' \
--header 'Content-Type: application/json' \
--data '{
    "memberNo": "27***85",
    "instanceNo": "25****11",
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`action`	String	-	リクエストタイプ
`member`	List<String>	-	ユーザー情報
`member.clientIp`	String	-	ユーザー IPアドレス
`member.instanceNo`	String	-	インスタンス作成時に付与された契約番号
`member.memberNo`	String	-	ユーザーの NAVERクラウドプラットフォーム会員番号
`member.memberName`	String	-	ユーザー名
`member.secureZoneNo`	String	-	Secure Zoneに付与された固有番号
`member.secureZoneName`	String	-	Secure Zone名
`member.status`	String	-	ユーザーの状態 `USE` \| `END`
`member.regYmdt`	Date	-	登録日
`returnCode`	Integer	-	レスポンスコード
`returnMessage`	String	-	レスポンスメッセージ

レスポンスステータスコード

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "action": "getMemberInfo",
  "returnCode": 0,
  "returnMessage": "success",
  "member": {
    "memberNo": "27***85",
    "instanceNo": "25****11",
    "memberName": "***",
    "secureZoneNo": "1",
    "secureZoneName": "Secure",
    "clientIp": "***.***.***.***",
    "status": "USE",
    "regYmdt": 1719379274000
  }
}

この記事は役に立ちましたか?

リクエスト
レスポンス

タグ

Secure Zone