S3 API Credentials

NHN Cloud > Public API User Guide > Authentication Methods > S3 API Credentials

S3 API credentials are AWS EC2-format authentication keys used to call the service APIs that support the Amazon S3 Compatible API in NHN Cloud. They consist of an Access Key and a Secret Key, and are used as the authentication method when calling the S3 compatible API. You can issue S3 API credentials directly from the NHN Cloud console or through the API.

Caution

  • S3 API credentials use a fixed-key authentication method with no expiration date. If a key is exposed externally, anyone can use the leaked key to access resources.
  • Store keys securely so that they are not included in external storage or code. If a leak is suspected, delete the credentials immediately, and then reissue them.
  • If the user who issued the S3 API credentials loses access permission to the project, or if the user's account is deleted after withdrawing from NHN Cloud, the credentials expire immediately and can no longer be used.

Note

Up to 3 S3 API credentials can be issued per project for each user.

Issue S3 API Credentials

Issue via Console

You can issue S3 API credentials from the console of a service that supports the Amazon S3 Compatible API. When issuing credentials from the console, the Secret Key can only be checked immediately after issuance, so be sure to store it separately. For more information, see the console guide for each service.

Issue via API

To obtain credentials using the API, an authentication token is required. To obtain the authentication token, refer to IaaS Token.

POST https://api-identity-infrastructure.nhncloudservice.com/v2.0/users/{api-user-id}/credentials/OS-EC2

Content-Type: application/json
X-Auth-Token: {token-id}

Request

Name Category Type Required Description
api-user-id URL String O API user ID
tenant_id Body String O Tenant ID found in API Endpoint Settings of the console for the service to use
Example

{
    "tenant_id": "84c9e9a51aea402e95389c08ac562ac5"
}

Response

Name Type Property Description
access Body String Access key of the S3 API credentials
secret Body String Secret key of the S3 API credentials
user_id Body String API user ID
tenant_id Body String Tenant ID
created_at Body String Creation time of the S3 API credentials
accessed_at Body String Last access time of the S3 API credentials
Example

{
    "credential": {
        "access": "253a3c7ca27f4731a9c757addfac29ca",
        "tenant_id": "84c9e9a51aea402e95389c08ac562ac5",
        "secret": "be057f235abf45ee8e2ba14edc5fb253",
        "user_id": "84db0c80-3c39-11e7-b29c-005056ac1497",
        "created_at": "2024-10-19T08:24:46.000000Z",
        "accessed_at": "2024-10-19T08:24:46.000000Z"
    }
}

Get S3 API Credentials

Retrieves a list of issued S3 API credentials.

GET https://api-identity-infrastructure.nhncloudservice.com/v2.0/users/{user-id}/credentials/OS-EC2

X-Auth-Token: {token-id}

Request

Name Category Type Required Description
user-id URL String O API user ID
X-Auth-Token Header String O Issued authentication token ID

Response

Name Type Property Description
access Body String Access key of the S3 API credentials
secret Body String Secret key of the S3 API credentials
user_id Body String API user ID
tenant_id Body String Tenant ID
created_at Body String Creation time of the S3 API credentials
accessed_at Body String Last access time of the S3 API credentials
Example

{
    "credentials": [
        {
            "access": "253a3c7ca27f4731a9c757addfac29ca",
            "tenant_id": "84c9e9a51aea402e95389c08ac562ac5",
            "secret": "be057f235abf45ee8e2ba14edc5fb253",
            "user_id": "84db0c80-3c39-11e7-b29c-005056ac1497",
            "created_at": "2024-10-19T08:24:46.000000Z",
            "accessed_at": "2024-10-19T08:30:42.000000Z"
        }
    ]
}

Delete S3 API Credentials

Deletes the issued S3 API credentials. If a leak is suspected, delete the credentials, and then reissue them.

DELETE https://api-identity-infrastructure.nhncloudservice.com/v2.0/users/{user-id}/credentials/OS-EC2/{access}

X-Auth-Token: {token-id}

Request

Name Category Type Required Description
user-id URL String O API user ID
access URL String O S3 API Access Key to delete
X-Auth-Token Header String O Issued authentication token ID

Use S3 API Credentials

S3 API credentials are used for authentication with the AWS Signature Version 4 signing method when calling the S3 compatible API. You can call the S3 compatible API by configuring the issued Access Key and Secret Key in an AWS SDK or an S3 compatible client. For more information about how to use, see the S3 compatible API guide for each service.

TOP