Roles

Roles define the permissions and access levels assigned to users within the system. Each role determines what actions a user can perform and which resources they can interact with.

https://api.validere.io/app

Create a Role

Create a role

post

Body

all ofOptional

Responses

200

A successful operation

application/json

Responseall of

and

post

HTTPcURLJavaScriptPython

POST /app/v1/roles HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "name": "text",
  "description": "text",
  "status": "active"
}

200

A successful operation

{
  "name": "text",
  "description": "text",
  "status": "active",
  "created_at": "2025-08-19T00:19:19.541Z",
  "updated_at": "2025-08-19T00:19:19.541Z",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "company_id": "123e4567-e89b-12d3-a456-426614174000"
}

Delete a Role

Delete a role

delete

Path parameters

role_idstring · uuidRequired

Role ID

Responses

200

successful operation

delete

HTTPcURLJavaScriptPython

DELETE /app/v1/roles/{role_id} HTTP/1.1
Host: api.validere.io
Accept: */*

200

successful operation

No content

Update a Role

Update a role

put

Path parameters

role_idstring · uuidRequired

Role ID

Body

namestringOptional

descriptionstringOptional

statusstring · enumOptionalPossible values:

Responses

200

A successful operation

application/json

Responseall of

and

put

HTTPcURLJavaScriptPython

PUT /app/v1/roles/{role_id} HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "name": "text",
  "description": "text",
  "status": "active"
}

200

A successful operation

{
  "name": "text",
  "description": "text",
  "status": "active",
  "created_at": "2025-08-19T00:19:19.541Z",
  "updated_at": "2025-08-19T00:19:19.541Z",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "company_id": "123e4567-e89b-12d3-a456-426614174000"
}

Get a Role

Must be Company member - Get a role

get

Path parameters

role_idstring · uuidRequired

Role ID

Responses

200

A successful operation

application/json

Responseall of

and

get

HTTPcURLJavaScriptPython

GET /app/v1/roles/{role_id} HTTP/1.1
Host: api.validere.io
Accept: */*

200

A successful operation

{
  "name": "text",
  "description": "text",
  "status": "active",
  "created_at": "2025-08-19T00:19:19.541Z",
  "updated_at": "2025-08-19T00:19:19.541Z",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "company_id": "123e4567-e89b-12d3-a456-426614174000"
}

Search Roles

Must be Company member - Search roles

post

Body

all ofOptional

and

and

Responses

200

successful operation

application/json

Responseall of

post

HTTPcURLJavaScriptPython

POST /app/v1/roles/search HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 386

{
  "page": 0,
  "page_size": 20,
  "sort_by": "name",
  "sort_direction": "desc",
  "filter": {
    "created_at": "2025-08-19T00:19:19.541Z",
    "updated_at": "2025-08-19T00:19:19.541Z",
    "created_by": "123e4567-e89b-12d3-a456-426614174000",
    "updated_by": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "status": "active",
    "user.id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

200

successful operation

{
  "page_number": 0,
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "name": "text",
      "description": "text",
      "status": "active"
    },
    {
      "created_at": "2025-08-19T00:19:19.541Z",
      "updated_at": "2025-08-19T00:19:19.541Z",
      "created_by": "123e4567-e89b-12d3-a456-426614174000",
      "updated_by": "123e4567-e89b-12d3-a456-426614174000"
    },
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "company_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Get Role Members

Must be Company member - Show Memberships for a role

get

Path parameters

role_idstring · uuidRequired

Role ID

Responses

200

A successful operation

application/json

get

HTTPcURLJavaScriptPython

GET /app/v1/roles/{role_id}/members HTTP/1.1
Host: api.validere.io
Accept: */*

200

A successful operation

[
  {
    "created_at": "2025-08-19T00:19:19.541Z",
    "updated_at": "2025-08-19T00:19:19.541Z",
    "created_by": "123e4567-e89b-12d3-a456-426614174000",
    "updated_by": "123e4567-e89b-12d3-a456-426614174000",
    "company_id": "123e4567-e89b-12d3-a456-426614174000",
    "role_id": "123e4567-e89b-12d3-a456-426614174000",
    "user_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  {
    "user": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "email": "[email protected]"
    }
  }
]

Assign Role to User

Add a user to a role

put

Path parameters

role_idstring · uuidRequired

Role ID

member_idstring · uuidRequired

Member ID

Responses

200

A successful operation

put

HTTPcURLJavaScriptPython

PUT /app/v1/roles/{role_id}/members/{member_id} HTTP/1.1
Host: api.validere.io
Accept: */*

200

A successful operation

No content

Remove Role from User

Remove a user from a role

delete

Path parameters

role_idstring · uuidRequired

Role ID

member_idstring · uuidRequired

Member ID

Responses

200

A successful operation

delete

HTTPcURLJavaScriptPython

DELETE /app/v1/roles/{role_id}/members/{member_id} HTTP/1.1
Host: api.validere.io
Accept: */*

200

A successful operation

No content