Edit Organization user

cURL

curl --request PUT \
  --url https://app.aegister.com/api/v1/organizations/{organizationid}/users/{userid} \
  --header 'Content-Type: application/json' \
  --header 'X-Aegister-Token: <api-key>' \
  --data '
{
  "email": "jsmith@example.com"
}
'

import requests

url = "https://app.aegister.com/api/v1/organizations/{organizationid}/users/{userid}"

payload = { "email": "jsmith@example.com" }
headers = {
    "X-Aegister-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-Aegister-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email: 'jsmith@example.com'})
};

fetch('https://app.aegister.com/api/v1/organizations/{organizationid}/users/{userid}', 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://app.aegister.com/api/v1/organizations/{organizationid}/users/{userid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'jsmith@example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Aegister-Token: <api-key>"
  ],
]);

$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://app.aegister.com/api/v1/organizations/{organizationid}/users/{userid}"

	payload := strings.NewReader("{\n  \"email\": \"jsmith@example.com\"\n}")

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

	req.Header.Add("X-Aegister-Token", "<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.put("https://app.aegister.com/api/v1/organizations/{organizationid}/users/{userid}")
  .header("X-Aegister-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"jsmith@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.aegister.com/api/v1/organizations/{organizationid}/users/{userid}")

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

request = Net::HTTP::Put.new(url)
request["X-Aegister-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"jsmith@example.com\"\n}"

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

{
  "error": 0,
  "messages": [],
  "data": {
    "organization": 123,
    "user": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": 1,
  "messages": [
    "Invalid data provided"
  ]
}

{
  "error": 1,
  "messages": [
    9153
  ]
}

{
  "error": 1,
  "messages": []
}

PUT

api

organizations

{organizationid}

users

{userid}

cURL

curl --request PUT \
  --url https://app.aegister.com/api/v1/organizations/{organizationid}/users/{userid} \
  --header 'Content-Type: application/json' \
  --header 'X-Aegister-Token: <api-key>' \
  --data '
{
  "email": "jsmith@example.com"
}
'

import requests

url = "https://app.aegister.com/api/v1/organizations/{organizationid}/users/{userid}"

payload = { "email": "jsmith@example.com" }
headers = {
    "X-Aegister-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-Aegister-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email: 'jsmith@example.com'})
};

fetch('https://app.aegister.com/api/v1/organizations/{organizationid}/users/{userid}', 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://app.aegister.com/api/v1/organizations/{organizationid}/users/{userid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'jsmith@example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Aegister-Token: <api-key>"
  ],
]);

$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://app.aegister.com/api/v1/organizations/{organizationid}/users/{userid}"

	payload := strings.NewReader("{\n  \"email\": \"jsmith@example.com\"\n}")

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

	req.Header.Add("X-Aegister-Token", "<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.put("https://app.aegister.com/api/v1/organizations/{organizationid}/users/{userid}")
  .header("X-Aegister-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"jsmith@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.aegister.com/api/v1/organizations/{organizationid}/users/{userid}")

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

request = Net::HTTP::Put.new(url)
request["X-Aegister-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"jsmith@example.com\"\n}"

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

{
  "error": 0,
  "messages": [],
  "data": {
    "organization": 123,
    "user": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": 1,
  "messages": [
    "Invalid data provided"
  ]
}

{
  "error": 1,
  "messages": [
    9153
  ]
}

{
  "error": 1,
  "messages": []
}

Authorizations

X-Aegister-Token

string

header

required

Path Parameters

organizationid

integer

required

userid

string

required

If the user is not already registered, this parameter can be 0.
In case is 0, the email field is required in the request body.

Body

role

enum<string>

Define user role inside the organization.
Assignable roles are:

owner: can manage all aspect of the organization
security_officer: can edit basic informations of the organization
viewer: can only view informations of the organization

Available options:

viewer,

security_officer,

owner

string<email>

This is required if userid path parameter is 0.

Response

error

integer

Any value different from 0 indicates an error.
More details can be found in messages.

Required range: 0 <= x <= 0

Example:

0

messages

array

If error is 1, contains zero or more details on the error.

Example:

[]

data

object

Show child attributes

API Documentation

Endpoints

Authorizations

Path Parameters

Body

Response