# Accounts API: Permissions

## GET /api/accounts/permissions/{permission}

>

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"ProblemDetails":{"type":"object","properties":{"Type":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Status":{"type":"integer","format":"int32","nullable":true},"Detail":{"type":"string","nullable":true},"Instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/accounts/permissions/{permission}":{"get":{"tags":["Accounts API: Permissions"],"parameters":[{"name":"permission","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}}}
```

## PUT /api/accounts/permissions/{permission}

>

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"ModifyPermission":{"type":"object","properties":{"GroupId":{"type":"string","format":"uuid"},"ObjectId":{"type":"string","format":"uuid"},"PermissionGrantedBy":{"type":"string","format":"uuid","nullable":true},"PermissionId":{"type":"string","format":"uuid"},"AllowAdministrate":{"type":"boolean"},"AllowConfigure":{"type":"boolean"},"AllowCreate":{"type":"boolean"},"AllowDelete":{"type":"boolean"},"AllowRead":{"type":"boolean"},"AllowTrialAccess":{"type":"boolean"},"AllowWrite":{"type":"boolean"},"ObjectType":{"type":"string","nullable":true},"PermissionGranted":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"ValidationFailure":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/Problem"},"nullable":true}},"additionalProperties":false},"Problem":{"type":"object","properties":{"Type":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Status":{"type":"integer","format":"int32","nullable":true},"Detail":{"type":"string","nullable":true},"Instance":{"type":"string","nullable":true}},"additionalProperties":{}},"ProblemDetails":{"type":"object","properties":{"Type":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Status":{"type":"integer","format":"int32","nullable":true},"Detail":{"type":"string","nullable":true},"Instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/accounts/permissions/{permission}":{"put":{"tags":["Accounts API: Permissions"],"parameters":[{"name":"permission","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ModifyPermission"}},"application/json":{"schema":{"$ref":"#/components/schemas/ModifyPermission"}},"text/json":{"schema":{"$ref":"#/components/schemas/ModifyPermission"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ModifyPermission"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationFailure"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}}}
```

## HEAD /api/accounts/permissions/{permission}

>

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}}},"paths":{"/api/accounts/permissions/{permission}":{"head":{"tags":["Accounts API: Permissions"],"parameters":[{"name":"permission","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"}},"text/json":{"schema":{"type":"boolean"}}}}}}}}}
```

## GET /api/accounts/permissions/count

>

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}}},"paths":{"/api/accounts/permissions/count":{"get":{"tags":["Accounts API: Permissions"],"parameters":[{"name":"OrganizationId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"PermissionGrantedSince","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"PermissionGrantedBefore","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"Identifier","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.When","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"Origin.Organization","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.User","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.Proxy","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.Description","in":"query","schema":{"type":"string"}},{"name":"Origin.Reason","in":"query","schema":{"type":"string"}},{"name":"Origin.Source","in":"query","schema":{"type":"string"}},{"name":"Filter.Page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Filter.PageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Filter.Sort","in":"query","schema":{"type":"string"}},{"name":"Filter.Excludes","in":"query","schema":{"type":"string"}},{"name":"Filter.Includes","in":"query","schema":{"type":"string"}},{"name":"Filter.Format","in":"query","schema":{"type":"string"}},{"name":"Texts","in":"query","schema":{"type":"object","additionalProperties":{"type":"string","nullable":true}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"integer","format":"int32"}},"text/json":{"schema":{"type":"integer","format":"int32"}}}}}}}}}
```

## GET /api/accounts/permissions

>

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"PermissionModel":{"type":"object","properties":{"GroupId":{"type":"string","format":"uuid"},"ObjectId":{"type":"string","format":"uuid"},"PermissionGrantedBy":{"type":"string","format":"uuid","nullable":true},"PermissionId":{"type":"string","format":"uuid"},"AllowAdministrate":{"type":"boolean"},"AllowConfigure":{"type":"boolean"},"AllowCreate":{"type":"boolean"},"AllowDelete":{"type":"boolean"},"AllowRead":{"type":"boolean"},"AllowTrialAccess":{"type":"boolean"},"AllowWrite":{"type":"boolean"},"ObjectType":{"type":"string","nullable":true},"PermissionGranted":{"type":"string","format":"date-time","nullable":true},"GroupName":{"type":"string","nullable":true},"OrganizationCode":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/api/accounts/permissions":{"get":{"tags":["Accounts API: Permissions"],"parameters":[{"name":"OrganizationId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"PermissionGrantedSince","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"PermissionGrantedBefore","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"Identifier","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.When","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"Origin.Organization","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.User","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.Proxy","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.Description","in":"query","schema":{"type":"string"}},{"name":"Origin.Reason","in":"query","schema":{"type":"string"}},{"name":"Origin.Source","in":"query","schema":{"type":"string"}},{"name":"Filter.Page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Filter.PageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Filter.Sort","in":"query","schema":{"type":"string"}},{"name":"Filter.Excludes","in":"query","schema":{"type":"string"}},{"name":"Filter.Includes","in":"query","schema":{"type":"string"}},{"name":"Filter.Format","in":"query","schema":{"type":"string"}},{"name":"Texts","in":"query","schema":{"type":"object","additionalProperties":{"type":"string","nullable":true}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PermissionModel"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PermissionModel"}}}}}}}}}}
```

## POST /api/accounts/permissions

>

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"CreatePermission":{"type":"object","properties":{"GroupId":{"type":"string","format":"uuid"},"ObjectId":{"type":"string","format":"uuid"},"PermissionGrantedBy":{"type":"string","format":"uuid","nullable":true},"PermissionId":{"type":"string","format":"uuid"},"AllowAdministrate":{"type":"boolean"},"AllowConfigure":{"type":"boolean"},"AllowCreate":{"type":"boolean"},"AllowDelete":{"type":"boolean"},"AllowRead":{"type":"boolean"},"AllowTrialAccess":{"type":"boolean"},"AllowWrite":{"type":"boolean"},"ObjectType":{"type":"string","nullable":true},"PermissionGranted":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"PermissionModel":{"type":"object","properties":{"GroupId":{"type":"string","format":"uuid"},"ObjectId":{"type":"string","format":"uuid"},"PermissionGrantedBy":{"type":"string","format":"uuid","nullable":true},"PermissionId":{"type":"string","format":"uuid"},"AllowAdministrate":{"type":"boolean"},"AllowConfigure":{"type":"boolean"},"AllowCreate":{"type":"boolean"},"AllowDelete":{"type":"boolean"},"AllowRead":{"type":"boolean"},"AllowTrialAccess":{"type":"boolean"},"AllowWrite":{"type":"boolean"},"ObjectType":{"type":"string","nullable":true},"PermissionGranted":{"type":"string","format":"date-time","nullable":true},"GroupName":{"type":"string","nullable":true},"OrganizationCode":{"type":"string","nullable":true}},"additionalProperties":false},"ValidationFailure":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/Problem"},"nullable":true}},"additionalProperties":false},"Problem":{"type":"object","properties":{"Type":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Status":{"type":"integer","format":"int32","nullable":true},"Detail":{"type":"string","nullable":true},"Instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/accounts/permissions":{"post":{"tags":["Accounts API: Permissions"],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreatePermission"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreatePermission"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreatePermission"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreatePermission"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationFailure"}}}}}}}}}
```

## GET /api/accounts/permissions/search

>

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"PermissionMatch":{"type":"object","properties":{"PermissionId":{"type":"string","format":"uuid"}},"additionalProperties":false}}},"paths":{"/api/accounts/permissions/search":{"get":{"tags":["Accounts API: Permissions"],"parameters":[{"name":"OrganizationId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"PermissionGrantedSince","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"PermissionGrantedBefore","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"Identifier","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.When","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"Origin.Organization","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.User","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.Proxy","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.Description","in":"query","schema":{"type":"string"}},{"name":"Origin.Reason","in":"query","schema":{"type":"string"}},{"name":"Origin.Source","in":"query","schema":{"type":"string"}},{"name":"Filter.Page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Filter.PageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Filter.Sort","in":"query","schema":{"type":"string"}},{"name":"Filter.Excludes","in":"query","schema":{"type":"string"}},{"name":"Filter.Includes","in":"query","schema":{"type":"string"}},{"name":"Filter.Format","in":"query","schema":{"type":"string"}},{"name":"Texts","in":"query","schema":{"type":"object","additionalProperties":{"type":"string","nullable":true}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PermissionMatch"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PermissionMatch"}}}}}}}}}}
```

## GET /api/accounts/permissions/refresh

>

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"ProblemDetails":{"type":"object","properties":{"Type":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Status":{"type":"integer","format":"int32","nullable":true},"Detail":{"type":"string","nullable":true},"Instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/accounts/permissions/refresh":{"get":{"tags":["Accounts API: Permissions"],"responses":{"200":{"description":"OK"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.shiftiq.com/developers/api-v2/navigating-the-api/accounts-api-permissions.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
