Groups

List Groups

get

Authorizations

Bearer Authentication

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Query parameters

filterstringOptional

The following filters are available:

• id with comparison operators eq co sw ew
• displayName with comparison operators eq co sw ew

Multiple filters can be used with the logical operators and or

Example: id eq "cksq4ybpq104zwgwh2gd1vvha"

startIndexintegerOptional

Index of the first query result

Default: 1

countinteger · min: 1 · max: 500Optional

Maximun numer of query results per page

Default: 500

sortBystring · enumOptionalDefault: idPossible values:

sortOrderstring · enumOptionalDefault: ascendingPossible values:

Responses

200Success

application/json

totalResultsintOptionalExample: 2

startIndexintOptionalExample: 1

itemsPerPageintOptionalExample: 500

400Error

application/json

get/Groups

HTTPcURLJavaScriptPython

GET /sso/{organisationId}/scim/v2/Groups HTTP/1.1
Host: api3.riskbase.uk/sso/{organisationId}/scim/v2
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 2,
  "startIndex": 1,
  "itemsPerPage": 500,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "id": "cksq4ybpq104zwgwh2gd1vvha",
      "displayName": "Admin",
      "name": "Admin",
      "description": "Access to admin features",
      "members": [
        "jo8woo84ow880s88wc4o8gw8"
      ],
      "meta": {
        "resourceType": "Group",
        "created": "2020-04-20T12:34:44Z",
        "lastModified": "2021-03-23T15:42:06Z",
        "location": "https://api3.riskbase.uk/sso/{organisationId}/scim/v2/Groups/cksq4ybpq104zwgwh2gd1vvha"
      }
    },
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "id": "ow4kswcsskwkc84s0g88okwc",
      "displayName": "Tasks",
      "name": "Tasks",
      "description": "Users with access to tasks",
      "members": [
        "jo8woo84ow880s88wc4o8gw8",
        "q0ssgs84sswkss4oo0s4008w"
      ],
      "meta": {
        "resourceType": "Group",
        "created": "2020-04-20T12:34:44Z",
        "lastModified": "2021-03-23T15:42:06Z",
        "location": "https://api3.riskbase.uk/sso/{organisationId}/scim/v2/Groups/ow4kswcsskwkc84s0g88okwc"
      }
    }
  ]
}

Create Group

post

Authorizations

Bearer Authentication

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Body

application/json

schemasstring[]Optional

namestringRequiredExample: Admin

descriptionstringOptionalExample: Access to admin features

Responses

201

See Get Group. Store the response's id and use this in future requests related to this group.

No content

400Error

application/json

409Error

application/json

post/Groups

HTTPcURLJavaScriptPython

POST /sso/{organisationId}/scim/v2/Groups HTTP/1.1
Host: api3.riskbase.uk/sso/{organisationId}/scim/v2
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "name": "Admin",
  "description": "Access to admin features",
  "members": [
    {
      "value": "jo8woo84ow880s88wc4o8gw8"
    }
  ]
}

No content

Get Group

get

Authorizations

Bearer Authentication

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters

idstringRequired

Responses

200Success

application/json

idstringOptional

displayNamestringOptional

namestringOptional

descriptionstringOptional

400Error

application/json

404Error

application/json

get/Groups/{id}

HTTPcURLJavaScriptPython

GET /sso/{organisationId}/scim/v2/Groups/{id} HTTP/1.1
Host: api3.riskbase.uk/sso/{organisationId}/scim/v2
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "cksq4ybpq104zwgwh2gd1vvha",
  "displayName": "Admin",
  "name": "Admin",
  "description": "Access to admin features",
  "members": [
    "jo8woo84ow880s88wc4o8gw8"
  ],
  "meta": {
    "resourceType": "Group",
    "created": "2020-04-20T12:34:44Z",
    "lastModified": "2021-03-23T15:42:06Z",
    "location": "https://api3.riskbase.uk/sso/{organisationId}/scim/v2/Groups/cksq4ybpq104zwgwh2gd1vvha"
  }
}

Overwrite Group

put

Authorizations

Bearer Authentication

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters

idstringRequired

Body

application/json

namestringRequiredExample: Admin

descriptionstringOptionalExample: Access to admin features

Responses

200

See Get Group

No content

400Error

application/json

404Error

application/json

409Error

application/json

put/Groups/{id}

HTTPcURLJavaScriptPython

PUT /sso/{organisationId}/scim/v2/Groups/{id} HTTP/1.1
Host: api3.riskbase.uk/sso/{organisationId}/scim/v2
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "name": "Admin",
  "description": "Access to admin features",
  "members": [
    {
      "value": "jo8woo84ow880s88wc4o8gw8"
    }
  ]
}

No content

Delete Group

delete

Authorizations

Bearer Authentication

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters

idstringRequired

Responses

204

Complete

No content

400Error

application/json

404Error

application/json

delete/Groups/{id}

HTTPcURLJavaScriptPython

DELETE /sso/{organisationId}/scim/v2/Groups/{id} HTTP/1.1
Host: api3.riskbase.uk/sso/{organisationId}/scim/v2
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Group

patch

Authorizations

Bearer Authentication

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters

idstringRequired

Body

application/json

Responses

200

See Get Group

No content

400Error

application/json

404Error

application/json

409Error

application/json

patch/Groups/{id}

HTTPcURLJavaScriptPython

PATCH /sso/{organisationId}/scim/v2/Groups/{id} HTTP/1.1
Host: api3.riskbase.uk/sso/{organisationId}/scim/v2
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 358

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "Operations": [
    {
      "op": "replace",
      "path": "name",
      "value": "Admin Users"
    },
    {
      "op": "remove",
      "path": "description"
    },
    {
      "op": "add",
      "path": "members",
      "value": [
        {
          "value": "pl34dje3i099d2djwoo2nhm2"
        },
        {
          "value": "ks9dii37ow890s88wd4o2nm8"
        }
      ]
    },
    {
      "op": "remove",
      "path": "members",
      "value": [
        {
          "value": "jo8woo84ow880s88wc4o8gw8"
        }
      ]
    }
  ]
}

No content