Security API: Permissions

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

permissionstring · uuidRequired

Responses

200

OK

application/jsontext/json

get

/api/security/permissions/{permission}

HTTPcURLJavaScriptPython

GET /v2/e01/api/security/permissions/{permission} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "groupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "permissionGrantedBy": "123e4567-e89b-12d3-a456-426614174000",
  "permissionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "allowAdministrate": true,
  "allowConfigure": true,
  "allowCreate": true,
  "allowDelete": true,
  "allowRead": true,
  "allowTrialAccess": true,
  "allowWrite": true,
  "objectType": "text",
  "permissionGranted": "2026-01-29T17:45:02.587Z",
  "groupName": "text",
  "organizationCode": "text"
}

put

Authorizations

BearerCookie

BearerstringRequired

Path parameters

permissionstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

groupIdentifierstring · uuidOptional

objectIdentifierstring · uuidOptional

organizationIdentifierstring · uuidOptional

permissionGrantedBystring · uuid · nullableOptional

permissionIdentifierstring · uuidOptional

allowAdministratebooleanOptional

allowConfigurebooleanOptional

allowCreatebooleanOptional

allowDeletebooleanOptional

allowReadbooleanOptional

allowTrialAccessbooleanOptional

allowWritebooleanOptional

objectTypestring · nullableOptional

permissionGrantedstring · date-time · nullableOptional

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

put

/api/security/permissions/{permission}

HTTPcURLJavaScriptPython

PUT /v2/e01/api/security/permissions/{permission} HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 514

{
  "groupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "permissionGrantedBy": "123e4567-e89b-12d3-a456-426614174000",
  "permissionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "allowAdministrate": true,
  "allowConfigure": true,
  "allowCreate": true,
  "allowDelete": true,
  "allowRead": true,
  "allowTrialAccess": true,
  "allowWrite": true,
  "objectType": "text",
  "permissionGranted": "2026-01-29T17:45:02.587Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

No content

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

permissionstring · uuidRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/security/permissions/{permission}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/security/permissions/{permission} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

BearerCookie

BearerstringRequired

Query parameters

GroupIdentifierstring · uuidOptional

ObjectIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

PermissionGrantedBystring · uuidOptional

AllowAdministratebooleanOptional

AllowConfigurebooleanOptional

AllowCreatebooleanOptional

AllowDeletebooleanOptional

AllowExecutebooleanOptional

AllowReadbooleanOptional

AllowTrialAccessbooleanOptional

AllowWritebooleanOptional

ObjectTypestringOptional

PermissionMaskinteger · int32Optional

PermissionGrantedstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/jsontext/json

Responseinteger · int32

get

/api/security/permissions/count

HTTPcURLJavaScriptPython

GET /v2/e01/api/security/permissions/count HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

BearerstringRequired

Query parameters

GroupIdentifierstring · uuidOptional

ObjectIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

PermissionGrantedBystring · uuidOptional

AllowAdministratebooleanOptional

AllowConfigurebooleanOptional

AllowCreatebooleanOptional

AllowDeletebooleanOptional

AllowExecutebooleanOptional

AllowReadbooleanOptional

AllowTrialAccessbooleanOptional

AllowWritebooleanOptional

ObjectTypestringOptional

PermissionMaskinteger · int32Optional

PermissionGrantedstring · date-timeOptional

ObjectNamestringOptional

GroupNamestringOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/jsontext/json

get

/api/security/permissions

HTTPcURLJavaScriptPython

GET /v2/e01/api/security/permissions HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "groupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "permissionGrantedBy": "123e4567-e89b-12d3-a456-426614174000",
    "permissionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "allowAdministrate": true,
    "allowConfigure": true,
    "allowCreate": true,
    "allowDelete": true,
    "allowRead": true,
    "allowTrialAccess": true,
    "allowWrite": true,
    "objectType": "text",
    "permissionGranted": "2026-01-29T17:45:02.587Z",
    "groupName": "text",
    "organizationCode": "text"
  }
]

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

groupIdentifierstring · uuidOptional

objectIdentifierstring · uuidOptional

organizationIdentifierstring · uuidOptional

permissionGrantedBystring · uuid · nullableOptional

permissionIdentifierstring · uuidOptional

allowAdministratebooleanOptional

allowConfigurebooleanOptional

allowCreatebooleanOptional

allowDeletebooleanOptional

allowReadbooleanOptional

allowTrialAccessbooleanOptional

allowWritebooleanOptional

objectTypestring · nullableOptional

permissionGrantedstring · date-time · nullableOptional

Responses

201

Created

application/json

400

Bad Request

application/json

post

/api/security/permissions

HTTPcURLJavaScriptPython

POST /v2/e01/api/security/permissions HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 514

{
  "groupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "permissionGrantedBy": "123e4567-e89b-12d3-a456-426614174000",
  "permissionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "allowAdministrate": true,
  "allowConfigure": true,
  "allowCreate": true,
  "allowDelete": true,
  "allowRead": true,
  "allowTrialAccess": true,
  "allowWrite": true,
  "objectType": "text",
  "permissionGranted": "2026-01-29T17:45:02.587Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "groupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "permissionGrantedBy": "123e4567-e89b-12d3-a456-426614174000",
  "permissionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "allowAdministrate": true,
  "allowConfigure": true,
  "allowCreate": true,
  "allowDelete": true,
  "allowRead": true,
  "allowTrialAccess": true,
  "allowWrite": true,
  "objectType": "text",
  "permissionGranted": "2026-01-29T17:45:02.587Z",
  "groupName": "text",
  "organizationCode": "text"
}

get

Authorizations

BearerCookie

BearerstringRequired

Query parameters

GroupIdentifierstring · uuidOptional

ObjectIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

PermissionGrantedBystring · uuidOptional

AllowAdministratebooleanOptional

AllowConfigurebooleanOptional

AllowCreatebooleanOptional

AllowDeletebooleanOptional

AllowExecutebooleanOptional

AllowReadbooleanOptional

AllowTrialAccessbooleanOptional

AllowWritebooleanOptional

ObjectTypestringOptional

PermissionMaskinteger · int32Optional

PermissionGrantedstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/jsontext/json

get

/api/security/permissions/search

HTTPcURLJavaScriptPython

GET /v2/e01/api/security/permissions/search HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "permissionIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

get

Authorizations

BearerCookie

BearerstringRequired

Responses

200

OK

No content

404

Not Found

get

/api/security/permissions/refresh

HTTPcURLJavaScriptPython

GET /v2/e01/api/security/permissions/refresh HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content