Accounts API: Permissions

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

permissionstring · uuidRequired

Responses

404

Not Found

application/jsontext/json

get

/api/accounts/permissions/{permission}

HTTPcURLJavaScriptPython

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

404

Not Found

{
  "Type": "text",
  "Title": "text",
  "Status": 1,
  "Detail": "text",
  "Instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

put

Authorizations

BearerCookie

BearerstringRequired

Path parameters

permissionstringRequired

Body

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

GroupIdstring · uuidOptional

ObjectIdstring · uuidOptional

PermissionGrantedBystring · uuid · nullableOptional

PermissionIdstring · 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

application/jsontext/json

put

/api/accounts/permissions/{permission}

HTTPcURLJavaScriptPython

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

{
  "GroupId": "123e4567-e89b-12d3-a456-426614174000",
  "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
  "PermissionGrantedBy": "123e4567-e89b-12d3-a456-426614174000",
  "PermissionId": "123e4567-e89b-12d3-a456-426614174000",
  "AllowAdministrate": true,
  "AllowConfigure": true,
  "AllowCreate": true,
  "AllowDelete": true,
  "AllowRead": true,
  "AllowTrialAccess": true,
  "AllowWrite": true,
  "ObjectType": "text",
  "PermissionGranted": "2026-05-07T18:19:45.251Z"
}

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

No content

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

permissionstring · uuidRequired

Responses

200

OK

application/jsontext/json

booleanOptional

head

/api/accounts/permissions/{permission}

HTTPcURLJavaScriptPython

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

200

OK

true

get

Authorizations

BearerCookie

BearerstringRequired

Query parameters

OrganizationIdstring · uuidOptional

PermissionGrantedSincestring · date-timeOptional

PermissionGrantedBeforestring · 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

integer · int32Optional

get

/api/accounts/permissions/count

HTTPcURLJavaScriptPython

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

200

OK

1

get

Authorizations

BearerCookie

BearerstringRequired

Query parameters

OrganizationIdstring · uuidOptional

PermissionGrantedSincestring · date-timeOptional

PermissionGrantedBeforestring · 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

GroupIdstring · uuidOptional

ObjectIdstring · uuidOptional

PermissionGrantedBystring · uuid · nullableOptional

PermissionIdstring · uuidOptional

AllowAdministratebooleanOptional

AllowConfigurebooleanOptional

AllowCreatebooleanOptional

AllowDeletebooleanOptional

AllowReadbooleanOptional

AllowTrialAccessbooleanOptional

AllowWritebooleanOptional

ObjectTypestring · nullableOptional

PermissionGrantedstring · date-time · nullableOptional

GroupNamestring · nullableOptional

OrganizationCodestring · nullableOptional

get

/api/accounts/permissions

HTTPcURLJavaScriptPython

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

200

OK

[
  {
    "GroupId": "123e4567-e89b-12d3-a456-426614174000",
    "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
    "PermissionGrantedBy": "123e4567-e89b-12d3-a456-426614174000",
    "PermissionId": "123e4567-e89b-12d3-a456-426614174000",
    "AllowAdministrate": true,
    "AllowConfigure": true,
    "AllowCreate": true,
    "AllowDelete": true,
    "AllowRead": true,
    "AllowTrialAccess": true,
    "AllowWrite": true,
    "ObjectType": "text",
    "PermissionGranted": "2026-05-07T18:19:45.251Z",
    "GroupName": "text",
    "OrganizationCode": "text"
  }
]

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

GroupIdstring · uuidOptional

ObjectIdstring · uuidOptional

PermissionGrantedBystring · uuid · nullableOptional

PermissionIdstring · 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/accounts/permissions

HTTPcURLJavaScriptPython

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

{
  "GroupId": "123e4567-e89b-12d3-a456-426614174000",
  "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
  "PermissionGrantedBy": "123e4567-e89b-12d3-a456-426614174000",
  "PermissionId": "123e4567-e89b-12d3-a456-426614174000",
  "AllowAdministrate": true,
  "AllowConfigure": true,
  "AllowCreate": true,
  "AllowDelete": true,
  "AllowRead": true,
  "AllowTrialAccess": true,
  "AllowWrite": true,
  "ObjectType": "text",
  "PermissionGranted": "2026-05-07T18:19:45.251Z"
}

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

{
  "GroupId": "123e4567-e89b-12d3-a456-426614174000",
  "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
  "PermissionGrantedBy": "123e4567-e89b-12d3-a456-426614174000",
  "PermissionId": "123e4567-e89b-12d3-a456-426614174000",
  "AllowAdministrate": true,
  "AllowConfigure": true,
  "AllowCreate": true,
  "AllowDelete": true,
  "AllowRead": true,
  "AllowTrialAccess": true,
  "AllowWrite": true,
  "ObjectType": "text",
  "PermissionGranted": "2026-05-07T18:19:45.251Z",
  "GroupName": "text",
  "OrganizationCode": "text"
}

get

Authorizations

BearerCookie

BearerstringRequired

Query parameters

OrganizationIdstring · uuidOptional

PermissionGrantedSincestring · date-timeOptional

PermissionGrantedBeforestring · 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

PermissionIdstring · uuidOptional

get

/api/accounts/permissions/search

HTTPcURLJavaScriptPython

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

200

OK

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

get

Authorizations

BearerCookie

BearerstringRequired

Responses

200

OK

No content

404

Not Found

application/jsontext/json

get

/api/accounts/permissions/refresh

HTTPcURLJavaScriptPython

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

No content