Activate or deactivate sub account access key
- Print
- PDF
Activate or deactivate sub account access key
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Suspend/resume the access key of a sub account.
Request
The following describes the request format for the endpoint. The request format is as follows:
Method | URI |
---|---|
PUT | /sub-accounts/{subAccountId}/access-keys |
Request headers
Field | Description |
---|---|
accept | Specify as application/JSON |
Request path parameters
The following describes the parameters.
Field | Type | Required | Description |
---|---|---|---|
subAccountId | String | Required | ID of sub account that owns the access key |
Request body parameter
The following describes the parameters.
Field | Type | Required | Description |
---|---|---|---|
accessKey | String | Required | Access Key Id |
active | Boolean | Required | Key activation status |
Request example
The following is a sample request.
curl -X PUT "https://subaccount.apigw.ntruss.com/api/v1/sub-accounts/{subAccountId}/access-keys"
-H "accept: application/json"
-H "x-ncp-iam-access-key: {access key}"
-H "x-ncp-apigw-timestamp: 1594646226859"
-H "x-ncp-apigw-signature-v2: {signature}"
-H "cache-control: no-cache"
-H "pragma: no-cache"
-d "{ \"accessKey\": \"{access key}\", \"active\": true}"
Response
The following describes the response format.
Response body
The following describes the response body.
Field | Type | Required | Description |
---|---|---|---|
ProcessResult | ProcessResult | - | Processing result |
Response status codes
Errors that may occur while using this action are listed below.
For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.
HTTP status code | Error code | Error message |
---|---|---|
401 | 30 | The account doesn't exist |
400 | 904 | The access key doesn't exist |
Response example
The following is a sample response.
{
"success": true
}
Was this article helpful?