Skip to main content
POST
/
v3
/
roles
/
definitions
Add Role Definition
curl --request POST \
  --url http://localhost/api/v3/roles/definitions \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "handle": "<string>",
  "description": "<string>",
  "short_description": "<string>",
  "icon": "<string>",
  "image_url": "<string>",
  "period": 123,
  "period_type": "days",
  "absolute_expiry": "<string>",
  "notes": "<string>",
  "group_name": "<string>",
  "group_handle": "<string>",
  "meta": [
    "<string>"
  ],
  "custom_fields": [
    {
      "namespace": "<string>",
      "handle": "<string>",
      "type": "string",
      "value": "<string>"
    }
  ]
}
'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "handle": "<string>",
    "description": "<string>",
    "short_description": "<string>",
    "icon": "<string>",
    "image_url": "<string>",
    "timezone": "<string>",
    "period": 123,
    "period_type": "<string>",
    "absolute_expiry": "<string>",
    "group_name": "<string>",
    "group_handle": "<string>",
    "notes": "<string>",
    "meta": [
      "<unknown>"
    ],
    "custom_fields": {},
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
name
string
required
handle
string
required
description
string | null
short_description
string | null
icon
string<uri> | null
image_url
string<uri> | null
period
integer | null
period_type
enum<string> | null
Available options:
days,
weeks,
months,
years,
absolute_date,
absolute_week,
absolute_month
absolute_expiry
string | null
notes
string | null
group_name
string | null
group_handle
string | null
meta
string[] | null
custom_fields
object[]

Response

RoleDefinition

data
RoleDefinition · object
required