Available in Classic and VPC
Get the profile list.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | /api/v1/profiles |
Request headers
For information about the headers common to all Global Edge APIs, see Global Edge request headers.
Request example
The request example is as follows:
curl --location --request GET 'https://edge.apigw.ntruss.com/api/v1/profiles' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
code |
String | - | Response code |
message |
String | - | Response message |
result |
Array | - | Profile list |
result
The following describes result
.
Field | Type | Required | Description |
---|---|---|---|
id |
Integer | - | Profile ID |
customerId |
Integer | - | User identification number |
profileName |
String | - | Profile name |
Note
The customerId
is a field that can be displayed in the response results but does not affect the use of the service.
Response status codes
For information about the HTTP status codes common to all Global Edge APIs, see Global Edge response status codes.
Response example
The response example is as follows:
{
"code": "0000",
"message": "Success",
"result": [
{
"id": 1599,
"customerId": 35,
"profileName": "myprofile"
},
{
"id": 1600,
"customerId": 35,
"profileName": "myprofile2"
}
]
}