Users

List Users

get

Returns a paginated list of users

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Query parameters

filterstringOptional

The following filters are available:

id with comparison operators eq co sw ew
userName with comparison operators eq co sw ew
name.familyName with comparison operators eq co sw ew
name.givenName with comparison operators eq co sw ew
email with comparison operators eq co sw ew
active with comparison operators eq

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: userNamePossible values:

sortOrderstring · enumOptionalDefault: ascendingPossible values:

Responses

200Success

application/json

schemasarray · enumOptionalPossible values:

totalResultsintOptionalExample: 1

startIndexintOptionalExample: 1

itemsPerPageintOptionalExample: 500

400Error

application/json

get/Users

GET /sso/{organisationId}/scim/v2/Users 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": 1,
  "startIndex": 1,
  "itemsPerPage": 500,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "id": "cksq4ybpq104zwgwh2gd1vvha",
      "email": [
        {
          "value": "ben.boyd@riskbase.uk",
          "type": "work",
          "primary": true
        }
      ],
      "name": {
        "formatted": "Ben Boyd",
        "givenName": "Ben",
        "familyName": "Boyd"
      },
      "authenticationType": "saml",
      "roles": [
        {
          "value": "cksq4ybpq104zwgwh2gd1vvha"
        }
      ],
      "meta": {
        "resourceType": "User",
        "created": "2020-04-20T12:34:44Z",
        "lastModified": "2021-03-23T15:42:06Z",
        "location": "https://api3.riskbase.uk/sso/{organisationId}/scim/v2/Users/cksq4ybpq104zwgwh2gd1vvha"
      }
    }
  ]
}

Create User

post

The POST request is used to create a new user.

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Body

schemasarrayOptionalExample: ["urn:ietf:params:scim:schemas:core:2.0:User"]

userNamestring · emailRequired

Your unique immutable ID

authenticationTypeenum · enumOptional

User should sign-in through your own IdP-initiated SAML SSO or directly into RiskBase with a passwordless account.

This cannot currently be changed once the user has been added. If you'd like to change an existing user's authenticationType, please get in touch with support@riskbase.uk

Default: samlPossible values:

activebooleanOptionalDefault: falseExample: true

Responses

201

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

No content

400Error

application/json

409Error

application/json

post/Users

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

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "name@gmail.com",
  "emails": [
    {
      "value": "ben.boyd@riskbase.uk",
      "primary": true
    }
  ],
  "name": {
    "givenName": "Ben",
    "familyName": "Boyd"
  },
  "authenticationType": "saml",
  "roles": [
    {
      "value": "text"
    }
  ],
  "active": true
}

No content

Get User

get

Return a single user

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters

idstringRequired

Responses

200Success

application/json

idstringOptional

externalIdstringOptional

userNamestringOptional

activebooleanOptional

400Error

application/json

404Error

application/json

get/Users/{id}

GET /sso/{organisationId}/scim/v2/Users/{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:User"
  ],
  "id": "cksq4ybpq104zwgwh2gd1vvha",
  "email": [
    {
      "value": "ben.boyd@riskbase.uk",
      "type": "work",
      "primary": true
    }
  ],
  "name": {
    "formatted": "Ben Boyd",
    "givenName": "Ben",
    "familyName": "Boyd"
  },
  "roles": [
    {
      "value": "cksq4ybpq104zwgwh2gd1vvha"
    }
  ],
  "meta": {
    "resourceType": "User",
    "created": "2020-04-20T12:34:44Z",
    "lastModified": "2021-03-23T15:42:06Z",
    "location": "https://api3.riskbase.uk/sso/{organisationId}/scim/v2/Users/cksq4ybpq104zwgwh2gd1vvha"
  }
}

Overwrite User

put

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Body

schemasarray · enumOptionalPossible values:

activebooleanOptionalDefault: falseExample: true

Responses

200

See Get User

No content

400Error

application/json

404Error

application/json

409Error

application/json

put/Users/{id}

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

{
  "schemas": "urn:ietf:params:scim:schemas:core:2.0:User",
  "emails": [
    {
      "value": "ben.boyd@riskbase.uk",
      "primary": true
    }
  ],
  "name": {
    "givenName": "Ben",
    "familyName": "Boyd"
  },
  "roles": [
    {
      "value": "text"
    }
  ],
  "active": true
}

No content

Delete User

delete

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters

idstringRequired

Responses

204

Complete

No content

400Error

application/json

404Error

application/json

delete/Users/{id}

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

No content

Update User

patch

Authorizations

AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters

idstringRequired

Body

Responses

200

See Get User

No content

400Error

application/json

404Error

application/json

409Error

application/json

patch/Users/{id}

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

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "Operations": [
    {
      "op": "replace",
      "path": "userName",
      "value": "new.email@riskbase.uk"
    },
    {
      "op": "replace",
      "path": "name.givenName",
      "value": "Brandon"
    },
    {
      "op": "replace",
      "path": "name",
      "value": {
        "familyName": "Kenney"
      }
    },
    {
      "op": "replace",
      "path": "emails",
      "value": [
        {
          "value": "brandon.kenney@riskbase.uk",
          "primary": true
        }
      ]
    },
    {
      "op": "remove",
      "path": "roles",
      "value": [
        {
          "value": "cksq4ybpq104zwgwh2gd1vvha"
        }
      ]
    },
    {
      "op": "add",
      "path": "roles",
      "value": [
        {
          "value": "cd2q4d0pq104zwgwh2gd1jkha"
        },
        {
          "value": "jw4w8gcs48s48w808kg4g0ck"
        }
      ]
    }
  ]
}

No content

PreviousGroups NextModels

Last updated 1 month ago

Was this helpful?