Skip to main content
POST
/
organization
/
{organizationId}
/
invite
Invite user to organization
curl --request POST \
  --url https://us.cybedefend.com/organization/{organizationId}/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "role": "administrator",
  "teamAssignments": [
    {
      "teamId": "550e8400-e29b-41d4-a716-446655440000",
      "role": "developer"
    },
    {
      "teamId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "role": "team_manager"
    }
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "token": "<string>",
  "email": "<string>",
  "status": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationName": "<string>",
  "organizationRole": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organizationId
string<uuid>
required

Organization identifier

Body

application/json
​
email
string<email>
required

Email of the person invited

​
role
enum<string>
required

Role to assign

Available options:
administrator,
manager,
billing_manager,
member
​
teamAssignments
object[]

Array of team assignments with roles for automatic addition upon invitation acceptance

Example:
[
  {
    "teamId": "550e8400-e29b-41d4-a716-446655440000",
    "role": "developer"
  },
  {
    "teamId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "role": "team_manager"
  }
]

Response

User invited to organization

​
id
string<uuid>
required

Invitation unique identifier

​
token
string
required

Invitation token

​
email
string
required

Email of the invitee

​
status
string
required

Current status of the invitation

​
organizationId
string<uuid>
required

Organization unique identifier

​
organizationName
string
required

Organization name

​
organizationRole
string
required

Role in the organization

​
expiresAt
string<date-time>
required

Invitation expiration date