getMemberInfo

Prev Next

Available in Classic

Get the Secure Zone service subscription information for a user account.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
POST /{type}/{zone}/getMemberInfo

Request headers

For headers common to Secure Zone APIs, see Secure Zone request headers.

Request path parameters

The following describes the parameters.

Field Type Required Description
type String Required firewall type provided by Secure Zone
  • szfw | psfw
    • szfw: Secure Zone Standard
    • psfw: Secure Zone Advanced
zone String Required Zone in which Secure Zone is configured
  • kr1 | kr2
    • kr1: KR-1 zone
    • kr2: KR-2 zone

Request body

The following describes the request body.

Field Type Required Description
memberNo String Optional User's NAVER Cloud Platform member ID
instanceNo String Optional Contract number assigned when creating the instance

Request example

The following is a sample request.

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",
}'

Response

The following describes the response format.

Response body

The following describes the response body.

Field Type Required Description
action String - Request type
member List<String> - User information
member.clientIp String - User IP address
member.instanceNo String - Contract number assigned when creating the instance
member.memberNo String - User's NAVER Cloud Platform member ID
member.memberName String - User name
member.secureZoneNo String - Unique number assigned to Secure Zone
member.secureZoneName String - Secure Zone name
member.status String - User status
  • USE | END
member.regYmdt Date - Registration Date
returnCode Integer - Response code
returnMessage String - Response message

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample example.

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