Invite User To Organization

POST 
/organizations/:org_id/workspaces/:workspace_id/invite

Assigns a role to a user in an organization.

Args: org_id (str): The ID of the organization. payload (InviteRequest): The payload containing the organization id, user email, and role to assign. workspace_id (str): The ID of the workspace.

Returns: bool: True if the role was successfully assigned, False otherwise.

Raises: HTTPException: If the user does not have permission to perform this action. HTTPException: If there is an error assigning the role to the user.

Request

Path Parameters

org_id Org Idrequired
workspace_id Workspace Idrequired

application/json

Body

arrayrequired

• Array [

email Email (string)required
roles string[]required

• ]

Responses

200

Successful Response

application/json

Schema

Schema

any

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...