Security: Permissions

get
Authorizations
Path parameters
permissionstring · uuidRequired
Responses
200

OK

application/json
get
GET /v2/E01/security/permissions/{permission} HTTP/1.1
Host: 
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,
  "AllowExecute": true,
  "AllowRead": true,
  "AllowTrialAccess": true,
  "AllowWrite": true,
  "ObjectType": "text",
  "PermissionMask": 1,
  "PermissionGranted": "2025-08-29T22:13:52.548Z",
  "RoleSlug": "text"
}
put
Authorizations
Path parameters
permissionstringRequired
Body
GroupIdentifierstring · uuidOptional
ObjectIdentifierstring · uuidOptional
OrganizationIdentifierstring · uuidOptional
PermissionGrantedBystring · uuid | nullableOptional
PermissionIdentifierstring · uuidOptional
AllowAdministratebooleanOptional
AllowConfigurebooleanOptional
AllowCreatebooleanOptional
AllowDeletebooleanOptional
AllowExecutebooleanOptional
AllowReadbooleanOptional
AllowTrialAccessbooleanOptional
AllowWritebooleanOptional
ObjectTypestring | nullableOptional
PermissionMaskinteger · int32Optional
PermissionGrantedstring · date-time | nullableOptional
Responses
200

OK

No content

put
PUT /v2/E01/security/permissions/{permission} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 553

{
  "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,
  "AllowExecute": true,
  "AllowRead": true,
  "AllowTrialAccess": true,
  "AllowWrite": true,
  "ObjectType": "text",
  "PermissionMask": 1,
  "PermissionGranted": "2025-08-29T22:13:52.548Z"
}

No content

delete
Authorizations
Path parameters
permissionstring · uuidRequired
Responses
200

OK

No content

delete
DELETE /v2/E01/security/permissions/{permission} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

No content

head
Authorizations
Path parameters
permissionstring · uuidRequired
Responses
200

OK

application/json
Responseboolean
head
HEAD /v2/E01/security/permissions/{permission} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*
200

OK

true
get
Authorizations
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/json
Responseinteger · int32
get
GET /v2/E01/security/permissions/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*
200

OK

1
get
Authorizations
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/json
get
GET /v2/E01/security/permissions HTTP/1.1
Host: 
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,
    "AllowExecute": true,
    "AllowRead": true,
    "AllowTrialAccess": true,
    "AllowWrite": true,
    "ObjectType": "text",
    "PermissionMask": 1,
    "PermissionGranted": "2025-08-29T22:13:52.548Z",
    "RoleSlug": "text"
  }
]
post
Authorizations
Body
GroupIdentifierstring · uuidOptional
ObjectIdentifierstring · uuidOptional
OrganizationIdentifierstring · uuidOptional
PermissionGrantedBystring · uuid | nullableOptional
PermissionIdentifierstring · uuidOptional
AllowAdministratebooleanOptional
AllowConfigurebooleanOptional
AllowCreatebooleanOptional
AllowDeletebooleanOptional
AllowExecutebooleanOptional
AllowReadbooleanOptional
AllowTrialAccessbooleanOptional
AllowWritebooleanOptional
ObjectTypestring | nullableOptional
PermissionMaskinteger · int32Optional
PermissionGrantedstring · date-time | nullableOptional
Responses
201

Created

application/json
post
POST /v2/E01/security/permissions HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 553

{
  "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,
  "AllowExecute": true,
  "AllowRead": true,
  "AllowTrialAccess": true,
  "AllowWrite": true,
  "ObjectType": "text",
  "PermissionMask": 1,
  "PermissionGranted": "2025-08-29T22:13:52.548Z"
}
{
  "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,
  "AllowExecute": true,
  "AllowRead": true,
  "AllowTrialAccess": true,
  "AllowWrite": true,
  "ObjectType": "text",
  "PermissionMask": 1,
  "PermissionGranted": "2025-08-29T22:13:52.548Z",
  "RoleSlug": "text"
}
Authorizations
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/json
get
GET /v2/E01/security/permissions/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*
200

OK

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

Was this helpful?