Identity SCIM v2

The Identity SCIM v2 API lets you provision and manage users and groups in Invicti Platform using the SCIM 2.0 standard. Use it to automate user lifecycle management from your identity provider.

For authentication and general Swagger UI navigation, refer to Use the Invicti Platform API. Open this API definition directly in Swagger UI.

Common examples

List users

Use this to retrieve all users in your organization, with optional filtering and sorting.

View list users example

Endpoint: GET /api/scim/v2/Users

Try it in Swagger UI:

1. Expand Users and select GET /api/scim/v2/Users.
2. Click Try it out.
3. Set count to control the page size and startIndex to paginate (1-based).
4. Optionally use filter to search, for example userName Eq "joe.bloggs@example.com".
5. Click Execute.

Example response:

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults": 2,
  "startIndex": 1,
  "itemsPerPage": 10,
  "Resources": [
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
      "userName": "joe.bloggs@example.com",
      "name": {
        "givenName": "Joe",
        "familyName": "Bloggs"
      },
      "meta": {
        "resourceType": "User",
        "created": "2025-11-01T12:00:00Z",
        "lastModified": "2025-11-01T12:00:00Z"
      }
    }
  ]
}

Create a user

Use this to provision a new user in Invicti Platform.

View create user example

Endpoint: POST /api/scim/v2/Users

Try it in Swagger UI:

1. Expand Users and select POST /api/scim/v2/Users.
2. Click Try it out.
3. Replace the example request body with your values:

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "userName": "string",
  "name": {
    "givenName": "string",
    "familyName": "string"
  },
  "password": "string",
  "locale": "string",
  "timezone": "string",
  "roles": ["string"]
}

4. Click Execute.

A successful response returns HTTP 201 Created with the new user's details including their id.

Update a user

Use this to update specific attributes of an existing user without replacing the entire record.

View update user example

Endpoint: PATCH /api/scim/v2/Users/{id}

Try it in Swagger UI:

1. Expand Users and select PATCH /api/scim/v2/Users/{id}.
2. Click Try it out.
3. Enter the user id.
4. Provide a PATCH operations body:

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    {
      "op": "replace",
      "path": "userName",
      "value": "string"
    }
  ]
}

5. Click Execute.

Supported op values: add, remove, replace

A successful response returns HTTP 200 with the updated user record.

Delete a user

Use this to deprovision a user from Invicti Platform.

View delete user example

Endpoint: DELETE /api/scim/v2/Users/{id}

Try it in Swagger UI:

1. Expand Users and select DELETE /api/scim/v2/Users/{id}.
2. Click Try it out.
3. Enter the id of the user to delete.
4. Click Execute.

A successful response returns HTTP 204 No Content.

warning

Deleting a user is permanent and cannot be undone.

List groups

Use this to retrieve all groups in your organization, including their members.

View list groups example

Endpoint: GET /api/scim/v2/Groups

Try it in Swagger UI:

1. Expand Groups and select GET /api/scim/v2/Groups.
2. Click Try it out.
3. Click Execute.

Example response:

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults": 1,
  "startIndex": 1,
  "itemsPerPage": 10,
  "Resources": [
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
      "displayName": "Administrators",
      "members": [
        {
          "value": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
          "display": "Joe Bloggs",
          "type": "User"
        }
      ],
      "meta": {
        "resourceType": "Group",
        "created": "2025-11-01T12:00:00Z",
        "lastModified": "2025-11-01T12:00:00Z"
      }
    }
  ]
}

Create a group

Use this to create a new group and optionally assign members to it.

View create group example

Endpoint: POST /api/scim/v2/Groups

Try it in Swagger UI:

1. Expand Groups and select POST /api/scim/v2/Groups.
2. Click Try it out.
3. Replace the example request body with your values:

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
  "displayName": "string",
  "members": [
    {
      "value": "string",
      "type": "User"
    }
  ]
}

4. Click Execute.

A successful response returns HTTP 201 Created with the new group details.

---

Need help?

The Support team is ready to provide you with technical help. Go to Help Center