# Security API: Permissions

## GET /api/security/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":{"PermissionModel":{"type":"object","properties":{"groupId":{"type":"string","format":"uuid"},"objectId":{"type":"string","format":"uuid"},"organizationId":{"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/security/permissions/{permission}":{"get":{"tags":["Security API: Permissions"],"parameters":[{"name":"permission","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/PermissionModel"}}}}}}}}}
```

## PUT /api/security/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"},"organizationId":{"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},"extensions":{"type":"object","additionalProperties":{"nullable":true},"nullable":true}},"additionalProperties":false}}},"paths":{"/api/security/permissions/{permission}":{"put":{"tags":["Security 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"}}}}}}
```

## HEAD /api/security/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/security/permissions/{permission}":{"head":{"tags":["Security 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/security/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/security/permissions/count":{"get":{"tags":["Security API: Permissions"],"parameters":[{"name":"GroupId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"ObjectId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"OrganizationId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"PermissionGrantedBy","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"AllowAdministrate","in":"query","schema":{"type":"boolean"}},{"name":"AllowConfigure","in":"query","schema":{"type":"boolean"}},{"name":"AllowCreate","in":"query","schema":{"type":"boolean"}},{"name":"AllowDelete","in":"query","schema":{"type":"boolean"}},{"name":"AllowExecute","in":"query","schema":{"type":"boolean"}},{"name":"AllowRead","in":"query","schema":{"type":"boolean"}},{"name":"AllowTrialAccess","in":"query","schema":{"type":"boolean"}},{"name":"AllowWrite","in":"query","schema":{"type":"boolean"}},{"name":"ObjectType","in":"query","schema":{"type":"string"}},{"name":"PermissionMask","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"PermissionGranted","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/security/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"},"organizationId":{"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/security/permissions":{"get":{"tags":["Security API: Permissions"],"parameters":[{"name":"GroupId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"ObjectId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"OrganizationId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"PermissionGrantedBy","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"AllowAdministrate","in":"query","schema":{"type":"boolean"}},{"name":"AllowConfigure","in":"query","schema":{"type":"boolean"}},{"name":"AllowCreate","in":"query","schema":{"type":"boolean"}},{"name":"AllowDelete","in":"query","schema":{"type":"boolean"}},{"name":"AllowExecute","in":"query","schema":{"type":"boolean"}},{"name":"AllowRead","in":"query","schema":{"type":"boolean"}},{"name":"AllowTrialAccess","in":"query","schema":{"type":"boolean"}},{"name":"AllowWrite","in":"query","schema":{"type":"boolean"}},{"name":"ObjectType","in":"query","schema":{"type":"string"}},{"name":"PermissionMask","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"PermissionGranted","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"ObjectName","in":"query","schema":{"type":"string"}},{"name":"GroupName","in":"query","schema":{"type":"string"}},{"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/security/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"},"organizationId":{"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"},"organizationId":{"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},"extensions":{"type":"object","additionalProperties":{"nullable":true},"nullable":true}},"additionalProperties":false}}},"paths":{"/api/security/permissions":{"post":{"tags":["Security 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/security/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/security/permissions/search":{"get":{"tags":["Security API: Permissions"],"parameters":[{"name":"GroupId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"ObjectId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"OrganizationId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"PermissionGrantedBy","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"AllowAdministrate","in":"query","schema":{"type":"boolean"}},{"name":"AllowConfigure","in":"query","schema":{"type":"boolean"}},{"name":"AllowCreate","in":"query","schema":{"type":"boolean"}},{"name":"AllowDelete","in":"query","schema":{"type":"boolean"}},{"name":"AllowExecute","in":"query","schema":{"type":"boolean"}},{"name":"AllowRead","in":"query","schema":{"type":"boolean"}},{"name":"AllowTrialAccess","in":"query","schema":{"type":"boolean"}},{"name":"AllowWrite","in":"query","schema":{"type":"boolean"}},{"name":"ObjectType","in":"query","schema":{"type":"string"}},{"name":"PermissionMask","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"PermissionGranted","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/security/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"}}},"paths":{"/api/security/permissions/refresh":{"get":{"tags":["Security API: Permissions"],"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"}}}}}}
```