MENU
      Create profile

        Create profile


        Article summary

        Available in Classic and VPC

        Create a profile. By mapping the role to which the external access service is applied to the profile, you can control the permissions so that the external workload targets whose identities have been verified can access the resources of the NAVER Cloud Platform.

        Request

        This section describes the request format. The method and URI are as follows:

        MethodURI
        POST/api/v1/profiles

        Request headers

        For information about the headers common to all Sub Account APIs, see Sub Account request headers.

        Request body

        You can include the following data in the body of your request:

        FieldTypeRequiredDescription
        nameStringRequiredProfile name
        • 3-30 characters using Korean, English uppercase and lowercase letters, Japanese, and special characters . _ -
        • First letter must be Korean, English uppercase and lowercase letter, or Japanese
        descriptionStringOptionalDescription of the profile (byte)
        • 0-300
        durationSecondsIntegerOptionalSession expiration time
        • Temporary credential duration (second)
        • 600-43,200 (default: 3600)
        enabledBooleanOptionalStatus
        • true | false (default)
          • true: enabled
          • false: disabled
        roleIdListArrayOptionalRole ID list
        • See Get role list
        • If null or[] is entered, it is created without a connected role
        • Used for temporary credentials
        • Only service roles with external access assigned can be used
        • Roles mapped to other profiles cannot be entered

        Request example

        The request example is as follows:

        curl --location --request POST 'https://externalaccess.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}' \
        --header 'Accept: application/json' \
        --header 'Content-Type: application/json' \
        --data '{
            "name": "profile000",
            "description": "profile",
            "durationSeconds": 600,
            "enabled": true,
            "roleIdList": []
        }'
        Shell

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        profileIdString-Profile ID
        profileNrnString-NAVER Cloud Platform resource identification value for profile
        nameString-Profile name
        descriptionString-Profile description
        enabledBoolean-Status
        • true | false
          • true: enabled
          • false: disabled
        durationSecondsInteger-Session expiration time
        • Temporary credential duration (second)
        roleNrnListArray-List of roles mapped to profile
        createTimeString-Creation date and time
        • ISO 8601 format
        updateTimeString-Last modification date and time
        • ISO 8601 format

        Response status codes

        For information about the HTTP status codes common to all Sub Account APIs, see Sub Account status codes.

        Response example

        The response example is as follows:

        {
            "profileId": "76da1a8c-****-****-****-cf13dfc49aa6",
            "profileNrn": "nrn:PUB:ExternalAccess::*******:Profile/76da1a8c-****-****-****-cf13dfc49aa6",
            "name": "profile000",
            "description": "profile",
            "enabled": true,
            "durationSeconds": 600,
            "roleNrnList": [],
            "createTime": "2024-12-13T14:24:45.128386464+09:00",
            "updateTime": "2024-12-13T14:24:45.128386464+09:00"
        }
        JSON

        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.