CAcautio
Gateway GRPC

Invite a user to an organisation

post/v2/organisations/{organisation_id}/users

Request

  • Base URL
    https://api.cautio.in (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

organisation_idstring required
Example:019aa01c-a1a9-7fae-961b-23845147892e

Organisation ID

Request body

emailstring

User's email address to invite

usernamestring

User's username

passwordstring

User's password

first_namestring required

User's first name

last_namestring required

User's last name

auto_assignboolean

Enable auto-assign for roles

Example request

{
  "email": "jane.doe@example.com",
  "username": "jane.doe",
  "password": "password123",
  "first_name": "Jane",
  "last_name": "Doe",
  "assignments": [
    {
      "role_id": "a9a7e4e8-3e4b-4b1a-8e4a-4a2a4a2a4a2a",
      "contexts": [
        {
          "organisation_id": "a9a7e4e8-3e4b-4b1a-8e4a-4a2a4a2a4a2a",
          "resource_type": "VEHICLE",
          "resource_ids": [
            "a9a7e4e8-3e4b-4b1a-8e4a-4a2a4a2a4a2a"
          ],
          "exclude_children": true
        }
      ]
    }
  ],
  "auto_assign": true
}

Response

Invited user details

idstring required

User ID

emailstring required

User Email

first_namestring required

User First Name

last_namestring required

User Last Name

usernamestring required

User Username

organisation_idstring required

Organisation ID

Example response

{
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Admin"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.