Invite account

Prev Next

Available in Classic and VPC

Invite an account to an organization.

Request

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

Method URI
POST /open-api/v1/account/invite

Request headers

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

Request body

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

Field Type Required Description
loginId String Required Invited account login ID
memberName String Required Invited account username
inviteMessage String Required Invitation message

Request example

The request example is as follows:

curl --location --request POST 'https://organization.apigw.ntruss.com/open-api/v1/account/invite' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "loginId": "n*******@navercorp.com",
    "memberName": "Gildong Hong",
    "inviteMessage": "You're invited to an organization."
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
result String - API processing result

Response status codes

For information about the HTTP status codes common to all Organization APIs, see Organization response status codes.

Response example

The response example is as follows:

{
    "result": "SUCCESS"
}