Request Schemas

This page centralizes the request schemas for a few commonly-used endpoints. The canonical source is api-reference/openapi.yml.

invite-user

Endpoint: POST /v1/invites Schema: InviteUserRequestSchema Body: application/json

Schema (OpenAPI-style)

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "email": "string",
    "name": "string",
    "role": "string",
    "policy": "string"
  }
}

Example

{
  "email": "john@doe.com",
  "name": "John Doe",
  "role": "Admin",
  "policy": "Admin"
}

assign-role

Endpoint: POST /v1/roles/assign Schema: AssignRoleRequestSchema Body: application/json

Schema (OpenAPI-style)

{
  "type": "object",
  "additionalProperties": false,
  "required": ["role", "userId"],
  "properties": {
    "role": "string",
    "userId": "string"
  }
}

Required fields

role: string
userId: string

Example

{
  "role": "Admin",
  "userId": "uuid"
}

revoke-role

Endpoint: POST /v1/roles/revoke Schema: RevokeRoleRequestSchema Body: application/json

Schema (OpenAPI-style)

{
  "type": "object",
  "additionalProperties": false,
  "required": ["role", "userId"],
  "properties": {
    "role": "string",
    "userId": "string"
  }
}

Required fields

role: string
userId: string

Example

{
  "role": "Admin",
  "userId": "uuid"
}

create-policy

Endpoint: POST /v1/users/policies Schema: CreatePolicyRequestSchema Body: application/json

Schema (OpenAPI-style)

{
  "type": "object",
  "additionalProperties": false,
  "required": ["name"],
  "properties": {
    "name": "string",
    "roles": "string[]",
    "functions": "string[]"
  }
}

Required fields

name: string

Optional fields

roles: string[]
functions: string[]

Example

{
  "name": "toManage",
  "roles": ["Admin"],
  "functions": ["fullDbPermission"]
}

update-policy

Endpoint: PATCH /v1/users/policies/{id} Schema: UpdatePolicyRequestSchema Path params:

id: string (required)

Body: application/json

Schema (OpenAPI-style)

{
  "type": "object",
  "additionalProperties": false,
  "required": ["name"],
  "properties": {
    "oldPolicyName": "string",
    "name": "string",
    "roles": "string[]",
    "functions": "string[]"
  }
}

Required fields

name: string

Optional fields

oldPolicyName: string
roles: string[]
functions: string[]

Example

{
  "oldPolicyName": "toManage (old)",
  "name": "toManage",
  "roles": ["Admin"],
  "functions": ["fullDbPermission"]
}

delete-policy

Endpoint: DELETE /v1/users/policies/{id} Path params (from components.parameters.Id):

id: string (required)

Body: none

Introduction Groups & Roles

Users

Roles

Database

Process

Measurements

Steps

Reports

Uploads

Policies

Legal Contracts

Policies

Organizations

Other

invite-user

Schema (OpenAPI-style)

Example

assign-role

Schema (OpenAPI-style)

Required fields

Example

revoke-role

Schema (OpenAPI-style)

Required fields

Example

create-policy

Schema (OpenAPI-style)

Required fields

Optional fields

Example

update-policy

Schema (OpenAPI-style)

Required fields

Optional fields

Example

delete-policy

​invite-user

​Schema (OpenAPI-style)

​Example

​assign-role

​Schema (OpenAPI-style)

​Required fields

​Example

​revoke-role

​Schema (OpenAPI-style)

​Required fields

​Example

​create-policy

​Schema (OpenAPI-style)

​Required fields

​Optional fields

​Example

​update-policy

​Schema (OpenAPI-style)

​Required fields

​Optional fields

​Example

​delete-policy

invite-user

Schema (OpenAPI-style)

Example

assign-role

Schema (OpenAPI-style)

Required fields

Example

revoke-role

Schema (OpenAPI-style)

Required fields

Example

create-policy

Schema (OpenAPI-style)

Required fields

Optional fields

Example

update-policy

Schema (OpenAPI-style)

Required fields

Optional fields

Example

delete-policy