Get authentication key list
    • PDF

    Get authentication key list

    • PDF

    Article summary

    Available in VPC

    Get the list of all generated authentication keys for NSML access.

    Request

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

    MethodURI
    GET/auth-keys

    Request headers

    For headers common to all CLOVA NSML APIs, see Common CLOVA NSML headers.

    Request example

    The following is a sample request.

    curl --location --request GET 'https://nsml.apigw.ntruss.com/nsml/v1/auth-keys' \
    --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-apigw-api-key: {API Key}' \
    --header 'Content-Type: application/json'
    

    Response

    The following describes the response format.

    Response body

    The following describes the response body.

    FieldTypeRequiredDescription
    keyListArray-Authentication key list
    totalCountInteger-Number of response results

    keyList

    The following describes keyList.

    FieldTypeRequiredDescription
    nameString-Authentication key name
    titleString-Authentication key ID
    fingerprintString-Authentication key identifier
    createTimeString-Authentication key creation date and time

    Response status codes

    For response status codes common to all CLOVA NSML APIs, see Common CLOVA NSML response status codes.

    Response example

    The following is a sample example.

    {
        "keyList": [
            {
                "name": "*********************************",
                "title": "authkey",
                "fingerprint": "**:**:**:**:**:**:**:**:**:**:**:**:**:**:**:**",
                "createTime": "2024-09-03 09:36:40"
            },
            {
                "name": "*********************************",
                "title": "authkey111",
                "fingerprint": "**:**:**:**:**:**:**:**:**:**:**:**:**:**:**:**",
                "createTime": "2024-09-03 09:51:36"
            }
        ],
        "totalCount": 2
    }
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.