Sign Up, Auth, Permission, SDK

This page describes how to sign up, sign in, get authentication key, configure permissions, and install KAS SDK.

You can use KAS after the e-mail authentication is completed. Access the membership page and enter the log-in information, name, phone number, and company information.

Click the "Join" button to send a verification email to the registered email address. Then, open the KAS authentication email, and look for the authentication number.

Enter this number in the KAS Console site to complete verification.

Once authenticated, you will be redirected to the log-in page.

For inquires about this document or KAS, please visit Developer Forum.

Once logged in, you will be redirected to the default dashboard page, where you can check the API usage by Klaytn accounts created in KAS.

For inquires about this document or KAS, please visit Developer Forum.

Generate API Authentication Key

API authentication key is used by a host calling the KAS API to check for KAS membership. The authentication key consists of AccessKey ID and Secret AccessKey, and enter the authentication key in the call header when calling the API by following these steps.

...
-u {access-key-id}:{secret-access-key}
...

Click Security - Credential menu on the Console dashboard.

Click the "Create AccessKey" button to create the AccessKey ID and Secret AccessKey. Click the "Download" button to download the created authentication key as a file (kas-credential-{access-key-id}.json).

An API authentication key can be created on KAS Console - Security - Credential menu, and the authentication password (Secret AccessKey) and Authorization can only be checked once upon their creation. Therefore, it is necessary to copy or download Secret AccessKey and Authorization to a safe location for proper and safe management after its creation. Authorization (e.g., Basic S0FTS1A2WkRaSjh...), which can be checked after creating an authentication key, refers to a value encoded using the AccessKey ID and Secret AccessKey through the basic authentication method and used for the call header when calling APIs.

A KAS API Authentication Key (API Auth Key) provides access to all KAS services and all the rights to a Klaytn account which was created by calling Wallet API via this API Auth Key. The rights here include accessing and transferring all the assets (KLAY, etc.) of or sending a transaction from a Klaytn account. If you shared your API Auth Key with any unauthorized personnel, your Klaytn account could be compromised and might cause unwanted transaction execution.

DO NOT share your API Auth Key (Secret AccessKey or Authorization) with any unauthorized personnel. DO PUT efforts necessary to keep your API Auth Key safe for the security of your KAS/Klaytn account.

Authentication keys can be created through the KAS Console - Security - Credential menu. Up to two authentication keys can be created. For replacing an authentication key, delete the existing key first before creating a new one.

For inquires about this document or KAS, please visit Developer Forum.

Configure Permissions for KAS Account

KAS permission is an object that has API call permission as the key:value type setting value. KAS evaluates a request using this permission when a user calls the API. The request may be accepted or denied depending on the permission object's setting value. Privileges are stored as JSON documents and include the following elements:

Statement - A permission can have several comments. Comments, such as Action, Resource, and Effect, are applied in OR relation when requests are evaluated.
- Action - Action refers to the list of allowed KAS APIs. Currently, all APIs (*) are permitted.
- Resource - Resource pertains to the list of allowed resources. KRN is used for this.
- Effect - Effect determines whether to accept or deny access to the APIs/resources set above (allow or deny).
- sid - The term "sid" is an annotation of permission settings.

For instance, privileges for using all APIs are granted to a user’s accounts if the following permission form is applied.

{
    "statement": [
        {
            "sid": "default",
            "effect": "allow",
            "action": ["*"],
            "resource": ["*"]
        }
    ]
}