Invite new user

Invite a user to the account.

User will receive an email. The new user will receive an invitation email with a link to create an account password, the existing user will be notified about the invitation to the account.

POST /iam/clients/invite_user

Invite new user

cURL

curl --request POST \
  --url https://api.gcore.com/iam/clients/invite_user \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[e-mail]",
  "user_role": {
    "id": 1,
    "name": "Administrators"
  },
  "client_id": 123,
  "name": "<string>"
}
'

import requests

url = "https://api.gcore.com/iam/clients/invite_user"

payload = {
    "email": "[e-mail]",
    "user_role": {
        "id": 1,
        "name": "Administrators"
    },
    "client_id": 123,
    "name": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: '[e-mail]',
    user_role: {id: 1, name: 'Administrators'},
    client_id: 123,
    name: '<string>'
  })
};

fetch('https://api.gcore.com/iam/clients/invite_user', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/iam/clients/invite_user",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => '[e-mail]',
    'user_role' => [
        'id' => 1,
        'name' => 'Administrators'
    ],
    'client_id' => 123,
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gcore.com/iam/clients/invite_user"

	payload := strings.NewReader("{\n  \"email\": \"[e-mail]\",\n  \"user_role\": {\n    \"id\": 1,\n    \"name\": \"Administrators\"\n  },\n  \"client_id\": 123,\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gcore.com/iam/clients/invite_user")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"[e-mail]\",\n  \"user_role\": {\n    \"id\": 1,\n    \"name\": \"Administrators\"\n  },\n  \"client_id\": 123,\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/iam/clients/invite_user")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"[e-mail]\",\n  \"user_role\": {\n    \"id\": 1,\n    \"name\": \"Administrators\"\n  },\n  \"client_id\": 123,\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "status": "sent",
  "user_id": 19449
}

{
  "errors": {
    "email": [
      "This field is required"
    ]
  }
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Body

application/json

email · string<email> · required

User email.

user_role · object · required

Show child attributes

client_id · integer · required

ID of account.

lang · enum<string>

User's language.

Defines language of the control panel and email messages.

Available options: de, en, ru, zh, az

name · string

User name.

Response

200

application/json

OK.

status · string · required

Status of the invitation.

user_id · integer · required

Invited user ID.