> For the complete documentation index, see [llms.txt](https://docs.riskbase.uk/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.riskbase.uk/riskbase-docs/scim/groups.md).

# Groups

## GET /Groups

> List Groups

```json
{"openapi":"3.1.1","info":{"title":"RiskBase SCIM Version 2.0","version":"0.0.1"},"tags":[{"name":"Groups","description":""}],"servers":[{"url":"https://api3.riskbase.uk/sso/{organisationId}/scim/v2"}],"security":[{"Bearer Authentication":[]}],"components":{"securitySchemes":{"Bearer Authentication":{"type":"http","scheme":"bearer","description":"`Authorization: Bearer {AuthorizationToken}`"}}},"paths":{"/Groups":{"get":{"tags":["Groups"],"summary":"List Groups","parameters":[{"schema":{"type":"string","description":"The following filters are available:\n\n- `id` with comparison operators `eq` `co` `sw` `ew`\n- `displayName` with comparison operators `eq` `co` `sw` `ew`\n\nMultiple filters can be used with the logical operators `and` `or`\n"},"in":"query","name":"filter"},{"schema":{"type":"integer","default":1},"in":"query","name":"startIndex","description":"Index of the first query result"},{"schema":{"type":"integer","minimum":1,"maximum":500,"default":500},"in":"query","name":"count","description":"Maximun numer of query results per page"},{"schema":{"type":"string","enum":["id","name","displayName"],"default":"id"},"in":"query","name":"sortBy"},{"schema":{"type":"string","enum":["ascending","descending"],"default":"ascending"},"in":"query","name":"sortOrder"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]}},"totalResults":{"type":"int"},"startIndex":{"type":"int"},"itemsPerPage":{"type":"int"},"Resources":{"type":"array","items":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:Group"]}},"id":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string","description":"Duplicate of `displayName`"},"description":{"type":"string"},"members":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}}}},"meta":{"type":"object","properties":{"resourceType":{"type":"string","enum":["Group"]},"created":{"type":"string"},"lastModified":{"type":"string"},"location":{"type":"string"}}}}}}}}}}},"400":{"content":{"application/json":{"schema":{"properties":{"schemas":{"type":"array"},"scimType":{"type":"string","enum":["invalidFilter"]},"detail":{"type":"string","enum":["Invalid filter"]},"status":{"type":"int","enum":[400]}}}}}}}}}}}
```

## POST /Groups

> Create Group

```json
{"openapi":"3.1.1","info":{"title":"RiskBase SCIM Version 2.0","version":"0.0.1"},"tags":[{"name":"Groups","description":""}],"servers":[{"url":"https://api3.riskbase.uk/sso/{organisationId}/scim/v2"}],"security":[{"Bearer Authentication":[]}],"components":{"securitySchemes":{"Bearer Authentication":{"type":"http","scheme":"bearer","description":"`Authorization: Bearer {AuthorizationToken}`"}}},"paths":{"/Groups":{"post":{"tags":["Groups"],"summary":"Create Group","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"schemas":{"type":"array","items":{"type":"string"}},"name":{"type":"string","required":true},"description":{"type":"string"},"members":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}}}}}}}}},"responses":{"201":{"description":"See **Get Group**. Store the response's `id` and use this in future requests related to this group."},"400":{"content":{"application/json":{"schema":{"properties":{"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","enum":["invalidValue"]},"detail":{"type":"string","enum":["displayName is required"]},"status":{"type":"int","enum":[400]}}}}}},"409":{"content":{"application/json":{"schema":{"properties":{"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","enum":["uniqueness"]},"detail":{"type":"string","enum":["displayName must be unique"]},"status":{"type":"int","enum":[409]}}}}}}}}}}}
```

## GET /Groups/{id}

> Get Group

```json
{"openapi":"3.1.1","info":{"title":"RiskBase SCIM Version 2.0","version":"0.0.1"},"tags":[{"name":"Groups","description":""}],"servers":[{"url":"https://api3.riskbase.uk/sso/{organisationId}/scim/v2"}],"security":[{"Bearer Authentication":[]}],"components":{"securitySchemes":{"Bearer Authentication":{"type":"http","scheme":"bearer","description":"`Authorization: Bearer {AuthorizationToken}`"}}},"paths":{"/Groups/{id}":{"get":{"tags":["Groups"],"summary":"Get Group","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:Group"]}},"id":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"members":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}}}},"meta":{"type":"object","properties":{"resourceType":{"type":"string","enum":["Group"]},"created":{"type":"string"},"lastModified":{"type":"string"},"location":{"type":"string"}}}}}}}},"400":{"content":{"application/json":{"schema":{"properties":{"schemas":{"type":"array","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]},"scimType":{"type":"string","enum":["invalidValue"]},"detail":{"type":"string","enum":["id is required"]},"status":{"type":"int","enum":[400]}}}}}},"404":{"content":{"application/json":{"schema":{"properties":{"schemas":{"type":"array","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]},"scimType":{"type":"string","enum":["invalidValue"]},"detail":{"type":"string","enum":["Resource not found"]},"status":{"type":"int","enum":[404]}}}}}}}}}}}
```

## PUT /Groups/{id}

> Overwrite Group

```json
{"openapi":"3.1.1","info":{"title":"RiskBase SCIM Version 2.0","version":"0.0.1"},"tags":[{"name":"Groups","description":""}],"servers":[{"url":"https://api3.riskbase.uk/sso/{organisationId}/scim/v2"}],"security":[{"Bearer Authentication":[]}],"components":{"securitySchemes":{"Bearer Authentication":{"type":"http","scheme":"bearer","description":"`Authorization: Bearer {AuthorizationToken}`"}}},"paths":{"/Groups/{id}":{"put":{"tags":["Groups"],"summary":"Overwrite Group","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:Group"]}},"name":{"type":"string","required":true},"description":{"type":"string"},"members":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}}}}}}}}},"responses":{"200":{"description":"See **Get Group**"},"400":{"content":{"application/json":{"schema":{"properties":{"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","enum":["invalidValue"]},"detail":{"type":"string","enum":["id is required","displayName is required"]},"status":{"type":"int","enum":[400]}}}}}},"404":{"content":{"application/json":{"schema":{"properties":{"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","enum":["invalidValue"]},"detail":{"type":"string","enum":["Resource not found"]},"status":{"type":"int","enum":[404]}}}}}},"409":{"content":{"application/json":{"schema":{"properties":{"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","enum":["uniqueness"]},"detail":{"type":"string","enum":["displayName must be unique"]},"status":{"type":"int","enum":[409]}}}}}}}}}}}
```

## DELETE /Groups/{id}

> Delete Group

```json
{"openapi":"3.1.1","info":{"title":"RiskBase SCIM Version 2.0","version":"0.0.1"},"tags":[{"name":"Groups","description":""}],"servers":[{"url":"https://api3.riskbase.uk/sso/{organisationId}/scim/v2"}],"security":[{"Bearer Authentication":[]}],"components":{"securitySchemes":{"Bearer Authentication":{"type":"http","scheme":"bearer","description":"`Authorization: Bearer {AuthorizationToken}`"}}},"paths":{"/Groups/{id}":{"delete":{"tags":["Groups"],"summary":"Delete Group","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"204":{"description":"Complete"},"400":{"content":{"application/json":{"schema":{"properties":{"schemas":{"type":"array","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]},"scimType":{"type":"string","enum":["invalidValue"]},"detail":{"type":"string","enum":["id is required"]},"status":{"type":"int","enum":[400]}}}}}},"404":{"content":{"application/json":{"schema":{"properties":{"schemas":{"type":"array","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]},"scimType":{"type":"string","enum":["invalidValue"]},"detail":{"type":"string","enum":["Resource not found"]},"status":{"type":"int","enum":[404]}}}}}}}}}}}
```

## PATCH /Groups/{id}

> Update Group

```json
{"openapi":"3.1.1","info":{"title":"RiskBase SCIM Version 2.0","version":"0.0.1"},"tags":[{"name":"Groups","description":""}],"servers":[{"url":"https://api3.riskbase.uk/sso/{organisationId}/scim/v2"}],"security":[{"Bearer Authentication":[]}],"components":{"securitySchemes":{"Bearer Authentication":{"type":"http","scheme":"bearer","description":"`Authorization: Bearer {AuthorizationToken}`"}}},"paths":{"/Groups/{id}":{"patch":{"tags":["Groups"],"summary":"Update Group","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["Operations"],"properties":{"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:Group"]}},"Operations":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["add","replace","remove"]},"path":{"type":"string","enum":["name","description","members"]},"value":{"type":"string | object"}}},"required":true}}}}}},"responses":{"200":{"description":"See **Get Group**"},"400":{"content":{"application/json":{"schema":{"properties":{"schemas":{"type":"array","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]},"scimType":{"type":"string","enum":["invalidValue"]},"detail":{"type":"string","enum":["id is required"]},"status":{"type":"int","enum":[400]}}}}}},"404":{"content":{"application/json":{"schema":{"properties":{"schemas":{"type":"array","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]},"scimType":{"type":"string","enum":["invalidValue"]},"detail":{"type":"string","enum":["Resource not found"]},"status":{"type":"int","enum":[404]}}}}}},"409":{"content":{"application/json":{"schema":{"properties":{"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","enum":["uniqueness"]},"detail":{"type":"string","enum":["displayName must be unique"]},"status":{"type":"int","enum":[409]}}}}}}}}}}}
```