Create Organization user

Create Organization’s user.

The authenticated user can add the user to the organization if is part of the organization and has Owner priviledges.

After the user has been added to the organization, an invitation email will be sent.

POST /api/v1/organizations/{organizationid}/users/{userid}

Try it

cURL

cURL

curl --request POST \
  --url https://app.aegister.com/api/v1/organizations/{organizationid}/users/{userid} \
  --header 'Content-Type: application/json' \
  --header 'X-Aegister-Token: <api-key>' \
  --data '
{
  "role": "viewer",
  "email": "[e-mail]"
}
'

200

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

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

email · string<email>

This is required if userid path parameter is 0.

Response

200

application/json

error · integer

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

Required range: 0 <= x <= 0

messages · array

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

data · object

Show child attributes

data. organization · number

Organization unique identifier.

data. user · string<uuid>

User unique identifier.
This can be 0 if the user is not registered.