Add Users To Organization

PUT 
/api/v1/organizations/:organization_id/users

Add a user to an organization.

Request

Path Parameters

organization_id uuidrequired

Cookie Parameters

session any

application/json

Body

array

required

• Array [

user_id

object

The user's ID.

anyOf

MOD1

string

email

object

The user's email address.

anyOf

MOD1

string

project_ids

object

required

The project IDs to add the user to.

anyOf

MOD1

Array [

string

]

role_id

object

The role ID to assign to the user.

anyOf

MOD1

string

• ]

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

id uuidrequired

Unique identifier

created_at

object

Creation datetime

anyOf

MOD1

string

updated_at

object

Update datetime

anyOf

MOD1

string

email emailrequired

The user's email address.

user_id

object

The user's ID.

anyOf

MOD1

string

organization_id uuidrequired

The organization's ID.

pending Pending (boolean)
Whether the user's membership is pending account signup.
Default value: true

invited_by_user_id

object

The user ID of the user who added the user to the organization.

anyOf

MOD1

string

invited_by_user_email

object

The email address of the user who added the user to the organization.

anyOf

MOD1

string

roles

object[]

required

The roles of the user in the organization.

Array [

id uuidrequired

Unique identifier

created_at

object

Creation datetime

anyOf

MOD1

string

updated_at

object

Update datetime

anyOf

MOD1

string

user_id User Id (string)required

The user's ID.

organization_id uuidrequired

The organization's ID.

role_id uuidrequired

The role's ID.

role

object

required

The role.

id uuidrequired

Unique identifier

created_at

object

Creation datetime

anyOf

MOD1

string

updated_at

object

Update datetime

anyOf

MOD1

string

name Name (string)required

A name for the role.

Possible values: non-empty and <= 3000 characters

organization_id

object

required

The organization's ID.

anyOf

MOD1

string

permissions

object[]

required

The actual permissions of the role.

Array [

id uuidrequired

Unique identifier

created_at

object

Creation datetime

anyOf

MOD1

string

updated_at

object

Update datetime

anyOf

MOD1

string

name Name (string)required

A name for the permission.

Possible values: non-empty and <= 3000 characters

description

object

required

A description for the permission.

anyOf

MOD1

string

access Access (boolean)required

Whether the permission is granted or not.

]

]

• ]

Example (from schema)

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "email": "user@example.com",
    "user_id": "string",
    "organization_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "pending": true,
    "invited_by_user_id": "string",
    "invited_by_user_email": "user@example.com",
    "roles": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "created_at": "2024-07-29T15:51:28.071Z",
        "updated_at": "2024-07-29T15:51:28.071Z",
        "user_id": "string",
        "organization_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "role_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "role": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "created_at": "2024-07-29T15:51:28.071Z",
          "updated_at": "2024-07-29T15:51:28.071Z",
          "name": "string",
          "organization_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "permissions": [
            {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "created_at": "2024-07-29T15:51:28.071Z",
              "updated_at": "2024-07-29T15:51:28.071Z",
              "name": "string",
              "description": "string",
              "access": true
            }
          ]
        }
      }
    ]
  }
]

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...