• Users
  • delDelete a SCIM user by id.
  • postCreate new SCIM user.
  • getList SCIM users.
  • getGet SCIM User by ID.
  • putUpdates an existing SCIM user by ID.
  • patchUpdates an existing SCIM user by ID via PATCH operations.

API docs by Redocly

Absorb SCIM API (v2)

Download OpenAPI specification:Download

Users

Delete a SCIM user by id.

This is soft delete.

path Parameters

userId required

string <guid> The ID specifying the user to delete.

Responses

https://{rootUrl}/scim/v2/Users/{userId}

Response samples

• 403
• 404

Content type

application/json

{

• "schemas": [

  • "string"

  ],
• "status": "string",
• "scimType": "invalidFilter",
• "detail": "string"

}

Create new SCIM user.

Request Body schema: application/json

The SCIM User.

schemas	Array of strings User schemas.
id	string <guid> A unique identifier for a SCIM request as defined by the service provider.
externalId	string A String that is an identifier for the request as defined by the provisioning client.
required	object The name of the user.
userName required	string non-empty The username of the user.
displayName	string The display name of the user.
title	string [ 0 .. 255 ] characters The title of the user.
active	boolean The active status of the user.
preferredLanguage	string [ 0 .. 7 ] characters The preferred language of the user.
password	string [ 0 .. 255 ] characters The password of the user.
	Array of objects (EmailRequest) The emails of the user.
	Array of objects (PhoneNumberRequest) The phone numbers of the user.
	Array of objects (AddressRequest) The addresses of the user.
	object The user's extended attributes.
	object The user's enterprise details.

Responses

Response Schema: application/json

schemas	Array of strings User schemas.
id	string <guid> A unique identifier for a SCIM resource as defined by the service provider.
externalId	string A String that is an identifier for the resource as defined by the provisioning client.
	object The name of the user.
userName	string The username of the user.
displayName	string The display name of the user.
title	string The title of the user.
active	boolean The active status of the user.
preferredLanguage	string The preferred language of the user.
password	string The password of the user.
	Array of objects (EmailResponse) The emails of the user.
	Array of objects (PhoneNumberResponse) The phone numbers of the user. The SCIM User/Phones is a List of Phones, which suppose to have multiple values, whether the AbsorbUser / phone is a single value
	Array of objects (AddressResponse) The addresses of the user.
	Array of objects (GroupResponse) The user's groups.
	object The user's extended attributes.
	object The user's enterprise details.
	object Attribute containing resource metadata.

https://{rootUrl}/scim/v2/Users

Request samples

• Payload

Content type

application/json

{

• "schemas": [

  • "string"

  ],
• "id": "string",
• "externalId": "string",
• "name": {

  • "givenName": "string",
  • "middleName": "string",
  • "familyName": "string"

  },
• "userName": "string",
• "displayName": "string",
• "title": "string",
• "active": true,
• "preferredLanguage": "string",
• "password": "string",
• "emails": [

  • {

    • "type": "string",
    • "primary": true,
    • "display": "string",
    • "value": "user@example.com",
    • "$ref": "http://example.com"

    }

  ],
• "phoneNumbers": [

  • {

    • "type": "string",
    • "primary": true,
    • "display": "string",
    • "value": "string",
    • "$ref": "http://example.com"

    }

  ],
• "addresses": [

  • {

    • "streetAddress": "string",
    • "locality": "string",
    • "region": "str",
    • "postalCode": "string",
    • "country": "str",
    • "type": "string",
    • "primary": true

    }

  ],
• "urn:ietf:params:scim:schemas:extension:absorb:2.0:User": {

  • "location": "string",
  • "dateHired": "2019-08-24T14:15:22Z",
  • "gender": 0,
  • "customFields": [

    • {

      • "type": "string",
      • "display": "string",
      • "value": null

      }

    ],
  • "userManagementSettings": {

    • "isLearner": true,
    • "isAdmin": true,
    • "isReviewer": true,
    • "isManager": true,
    • "isInstructor": true,
    • "adminRoles": [

      • "string"

      ],
    • "userManagementType": 0,
    • "managedGroupId": "string",
    • "managedDepartments": [

      • {

        • "departmentId": "string",
        • "includeSubDepartments": true

        }

      ],
    • "managerRoles": [

      • "string"

      ]

    }

  },
• "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {

  • "employeeNumber": "string",
  • "manager": {

    • "value": "string"

    }

  }

}

Response samples

• 200
• 400
• 409

Content type

application/json

{

• "schemas": [

  • "string"

  ],
• "id": "string",
• "externalId": "string",
• "name": {

  • "givenName": "string",
  • "middleName": "string",
  • "familyName": "string"

  },
• "userName": "string",
• "displayName": "string",
• "title": "string",
• "active": true,
• "preferredLanguage": "string",
• "password": "string",
• "emails": [

  • {

    • "type": "string",
    • "primary": true,
    • "display": "string",
    • "value": "string",
    • "$ref": "http://example.com"

    }

  ],
• "phoneNumbers": [

  • {

    • "type": "string",
    • "primary": true,
    • "display": "string",
    • "value": "string",
    • "$ref": "http://example.com"

    }

  ],
• "addresses": [

  • {

    • "streetAddress": "string",
    • "locality": "string",
    • "region": "string",
    • "postalCode": "string",
    • "country": "string",
    • "type": "string",
    • "primary": true

    }

  ],
• "groups": [

  • {

    • "type": "string",
    • "primary": true,
    • "display": "string",
    • "value": "string",
    • "$ref": "http://example.com"

    }

  ],
• "urn:ietf:params:scim:schemas:extension:absorb:2.0:User": {

  • "location": "string",
  • "dateHired": "2019-08-24T14:15:22Z",
  • "gender": 0,
  • "customFields": [

    • {

      • "type": "string",
      • "display": "string",
      • "value": null

      }

    ],
  • "userManagementSettings": {

    • "isLearner": true,
    • "isAdmin": true,
    • "isReviewer": true,
    • "isManager": true,
    • "isInstructor": true,
    • "adminRoles": [

      • "string"

      ],
    • "userManagementType": 0,
    • "managerRoles": [

      • "string"

      ],
    • "mangedGroupId": "string",
    • "managedDepartments": [

      • {

        • "departmentId": "string",
        • "includeSubDepartments": true

        }

      ]

    }

  },
• "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {

  • "employeeNumber": "string",
  • "manager": {

    • "value": "string"

    }

  },
• "meta": {

  • "resourceType": "User",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "location": "http://example.com"

  }

}

List SCIM users.

query Parameters

filter	object The filter for the query request.
sortBy	string Specify the attribute to sort the response by.
sortOrder	string Enum: "Ascending" "Descending" Specify the order to sort the response by.
startIndex	integer <int32> Specify the index to start the response from.
count	integer <int32> Specify how many results to return.
attributes	Array of strings The list of attributes to include in the response.
excludedAttributes	Array of strings The list of attributes to exclude from the response.

Responses

Response Schema: application/json

schemas	Array of strings The response schemas.
totalResults	integer <int32> The total number of results returned.
startIndex	integer <int32> The 1-based index of the first result in the current set of search results.
itemsPerPage	integer <int32> The number of results returned on a page.
	Array of objects (UserResponse) The list of returned resources.

https://{rootUrl}/scim/v2/Users

Response samples

• 200
• 400

Content type

application/json

{

• "schemas": [

  • "string"

  ],
• "totalResults": 0,
• "startIndex": 0,
• "itemsPerPage": 0,
• "Resources": [

  • {

    • "schemas": [

      • "string"

      ],
    • "id": "string",
    • "externalId": "string",
    • "name": {

      • "givenName": "string",
      • "middleName": "string",
      • "familyName": "string"

      },
    • "userName": "string",
    • "displayName": "string",
    • "title": "string",
    • "active": true,
    • "preferredLanguage": "string",
    • "password": "string",
    • "emails": [

      • {

        • "type": "string",
        • "primary": true,
        • "display": "string",
        • "value": "string",
        • "$ref": "http://example.com"

        }

      ],
    • "phoneNumbers": [

      • {

        • "type": "string",
        • "primary": true,
        • "display": "string",
        • "value": "string",
        • "$ref": "http://example.com"

        }

      ],
    • "addresses": [

      • {

        • "streetAddress": "string",
        • "locality": "string",
        • "region": "string",
        • "postalCode": "string",
        • "country": "string",
        • "type": "string",
        • "primary": true

        }

      ],
    • "groups": [

      • {

        • "type": "string",
        • "primary": true,
        • "display": "string",
        • "value": "string",
        • "$ref": "http://example.com"

        }

      ],
    • "urn:ietf:params:scim:schemas:extension:absorb:2.0:User": {

      • "location": "string",
      • "dateHired": "2019-08-24T14:15:22Z",
      • "gender": 0,
      • "customFields": [

        • {

          • "type": "string",
          • "display": "string",
          • "value": null

          }

        ],
      • "userManagementSettings": {

        • "isLearner": true,
        • "isAdmin": true,
        • "isReviewer": true,
        • "isManager": true,
        • "isInstructor": true,
        • "adminRoles": [

          • "string"

          ],
        • "userManagementType": 0,
        • "managerRoles": [

          • "string"

          ],
        • "mangedGroupId": "string",
        • "managedDepartments": [

          • {

            • "departmentId": "string",
            • "includeSubDepartments": true

            }

          ]

        }

      },
    • "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {

      • "employeeNumber": "string",
      • "manager": {

        • "value": "string"

        }

      },
    • "meta": {

      • "resourceType": "User",
      • "created": "2019-08-24T14:15:22Z",
      • "lastModified": "2019-08-24T14:15:22Z",
      • "location": "http://example.com"

      }

    }

  ]

}

Get SCIM User by ID.

path Parameters

id required

string <guid> The ID specifying the user to retrieve.

query Parameters

attributes	Array of strings The list of attributes to include in the response.
excludedAttributes	Array of strings The list of attributes to exclude from the response.

Responses

Response Schema: application/json

schemas	Array of strings User schemas.
id	string <guid> A unique identifier for a SCIM resource as defined by the service provider.
externalId	string A String that is an identifier for the resource as defined by the provisioning client.
	object The name of the user.
userName	string The username of the user.
displayName	string The display name of the user.
title	string The title of the user.
active	boolean The active status of the user.
preferredLanguage	string The preferred language of the user.
password	string The password of the user.
	Array of objects (EmailResponse) The emails of the user.
	Array of objects (PhoneNumberResponse) The phone numbers of the user. The SCIM User/Phones is a List of Phones, which suppose to have multiple values, whether the AbsorbUser / phone is a single value
	Array of objects (AddressResponse) The addresses of the user.
	Array of objects (GroupResponse) The user's groups.
	object The user's extended attributes.
	object The user's enterprise details.
	object Attribute containing resource metadata.

https://{rootUrl}/scim/v2/Users/{id}

Response samples

• 200
• 404

Content type

application/json

{

• "schemas": [

  • "string"

  ],
• "id": "string",
• "externalId": "string",
• "name": {

  • "givenName": "string",
  • "middleName": "string",
  • "familyName": "string"

  },
• "userName": "string",
• "displayName": "string",
• "title": "string",
• "active": true,
• "preferredLanguage": "string",
• "password": "string",
• "emails": [

  • {

    • "type": "string",
    • "primary": true,
    • "display": "string",
    • "value": "string",
    • "$ref": "http://example.com"

    }

  ],
• "phoneNumbers": [

  • {

    • "type": "string",
    • "primary": true,
    • "display": "string",
    • "value": "string",
    • "$ref": "http://example.com"

    }

  ],
• "addresses": [

  • {

    • "streetAddress": "string",
    • "locality": "string",
    • "region": "string",
    • "postalCode": "string",
    • "country": "string",
    • "type": "string",
    • "primary": true

    }

  ],
• "groups": [

  • {

    • "type": "string",
    • "primary": true,
    • "display": "string",
    • "value": "string",
    • "$ref": "http://example.com"

    }

  ],
• "urn:ietf:params:scim:schemas:extension:absorb:2.0:User": {

  • "location": "string",
  • "dateHired": "2019-08-24T14:15:22Z",
  • "gender": 0,
  • "customFields": [

    • {

      • "type": "string",
      • "display": "string",
      • "value": null

      }

    ],
  • "userManagementSettings": {

    • "isLearner": true,
    • "isAdmin": true,
    • "isReviewer": true,
    • "isManager": true,
    • "isInstructor": true,
    • "adminRoles": [

      • "string"

      ],
    • "userManagementType": 0,
    • "managerRoles": [

      • "string"

      ],
    • "mangedGroupId": "string",
    • "managedDepartments": [

      • {

        • "departmentId": "string",
        • "includeSubDepartments": true

        }

      ]

    }

  },
• "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {

  • "employeeNumber": "string",
  • "manager": {

    • "value": "string"

    }

  },
• "meta": {

  • "resourceType": "User",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "location": "http://example.com"

  }

}

Updates an existing SCIM user by ID.

Clients that want to override a server's defaults MAY specify "null" for a single-valued attribute, or an empty array "[]" for a multivalued attribute, to clear all values.

path Parameters

id required

string <guid> The user's ID

Request Body schema: application/json

The request body to update the given user.

id	string <guid>
schemas	Array of strings User schemas.
externalId	string A String that is an identifier for the request as defined by the provisioning client.
required	object The name of the user.
userName required	string non-empty The username of the user.
displayName	string The display name of the user.
title	string [ 0 .. 255 ] characters The title of the user.
active	boolean The active status of the user. If null, defaults to Inactive.
preferredLanguage	string [ 0 .. 7 ] characters The preferred language of the user.
password	string The password of the user. If password == null, no updates will be made.
	Array of objects (EmailRequest) The emails of the user.
	Array of objects (PhoneNumberRequest) The phone numbers of the user.
	Array of objects (AddressRequest) The addresses of the user.
	object The user's extended attributes.
	object The user's enterprise details.

Responses

Response Schema: application/json

schemas	Array of strings User schemas.
id	string <guid> A unique identifier for a SCIM resource as defined by the service provider.
externalId	string A String that is an identifier for the resource as defined by the provisioning client.
	object The name of the user.
userName	string The username of the user.
displayName	string The display name of the user.
title	string The title of the user.
active	boolean The active status of the user.
preferredLanguage	string The preferred language of the user.
password	string The password of the user.
	Array of objects (EmailResponse) The emails of the user.
	Array of objects (PhoneNumberResponse) The phone numbers of the user. The SCIM User/Phones is a List of Phones, which suppose to have multiple values, whether the AbsorbUser / phone is a single value
	Array of objects (AddressResponse) The addresses of the user.
	Array of objects (GroupResponse) The user's groups.
	object The user's extended attributes.
	object The user's enterprise details.
	object Attribute containing resource metadata.

https://{rootUrl}/scim/v2/Users/{id}

Request samples

• Payload

Content type

application/json

{

• "id": "string",
• "schemas": [

  • "string"

  ],
• "externalId": "string",
• "name": {

  • "givenName": "string",
  • "middleName": "string",
  • "familyName": "string"

  },
• "userName": "string",
• "displayName": "string",
• "title": "string",
• "active": true,
• "preferredLanguage": "string",
• "password": "string",
• "emails": [

  • {

    • "type": "string",
    • "primary": true,
    • "display": "string",
    • "value": "user@example.com",
    • "$ref": "http://example.com"

    }

  ],
• "phoneNumbers": [

  • {

    • "type": "string",
    • "primary": true,
    • "display": "string",
    • "value": "string",
    • "$ref": "http://example.com"

    }

  ],
• "addresses": [

  • {

    • "streetAddress": "string",
    • "locality": "string",
    • "region": "str",
    • "postalCode": "string",
    • "country": "str",
    • "type": "string",
    • "primary": true

    }

  ],
• "urn:ietf:params:scim:schemas:extension:absorb:2.0:User": {

  • "location": "string",
  • "dateHired": "2019-08-24T14:15:22Z",
  • "gender": 0,
  • "customFields": [

    • {

      • "type": "string",
      • "display": "string",
      • "value": null

      }

    ],
  • "userManagementSettings": {

    • "isLearner": true,
    • "isAdmin": true,
    • "isReviewer": true,
    • "isManager": true,
    • "isInstructor": true,
    • "adminRoles": [

      • "string"

      ],
    • "userManagementType": 0,
    • "managedGroupId": "string",
    • "managedDepartments": [

      • {

        • "departmentId": "string",
        • "includeSubDepartments": true

        }

      ],
    • "managerRoles": [

      • "string"

      ]

    }

  },
• "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {

  • "employeeNumber": "string",
  • "manager": {

    • "value": "string"

    }

  }

}

Response samples

• 200
• 400
• 404
• 409

Content type

application/json

{

• "schemas": [

  • "string"

  ],
• "id": "string",
• "externalId": "string",
• "name": {

  • "givenName": "string",
  • "middleName": "string",
  • "familyName": "string"

  },
• "userName": "string",
• "displayName": "string",
• "title": "string",
• "active": true,
• "preferredLanguage": "string",
• "password": "string",
• "emails": [

  • {

    • "type": "string",
    • "primary": true,
    • "display": "string",
    • "value": "string",
    • "$ref": "http://example.com"

    }

  ],
• "phoneNumbers": [

  • {

    • "type": "string",
    • "primary": true,
    • "display": "string",
    • "value": "string",
    • "$ref": "http://example.com"

    }

  ],
• "addresses": [

  • {

    • "streetAddress": "string",
    • "locality": "string",
    • "region": "string",
    • "postalCode": "string",
    • "country": "string",
    • "type": "string",
    • "primary": true

    }

  ],
• "groups": [

  • {

    • "type": "string",
    • "primary": true,
    • "display": "string",
    • "value": "string",
    • "$ref": "http://example.com"

    }

  ],
• "urn:ietf:params:scim:schemas:extension:absorb:2.0:User": {

  • "location": "string",
  • "dateHired": "2019-08-24T14:15:22Z",
  • "gender": 0,
  • "customFields": [

    • {

      • "type": "string",
      • "display": "string",
      • "value": null

      }

    ],
  • "userManagementSettings": {

    • "isLearner": true,
    • "isAdmin": true,
    • "isReviewer": true,
    • "isManager": true,
    • "isInstructor": true,
    • "adminRoles": [

      • "string"

      ],
    • "userManagementType": 0,
    • "managerRoles": [

      • "string"

      ],
    • "mangedGroupId": "string",
    • "managedDepartments": [

      • {

        • "departmentId": "string",
        • "includeSubDepartments": true

        }

      ]

    }

  },
• "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {

  • "employeeNumber": "string",
  • "manager": {

    • "value": "string"

    }

  },
• "meta": {

  • "resourceType": "User",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "location": "http://example.com"

  }

}

Updates an existing SCIM user by ID via PATCH operations.

path Parameters

id required

string <guid> The user's ID.

query Parameters

attributes	Array of strings The list of attributes to include in the response.
excludedAttributes	Array of strings The list of attributes to exclude from the response.

Request Body schema: application/json

The list of patch operations to perform.

schemas required	Array of strings The request schemas.
required	Array of objects (PatchOperation) The list of patch operations

Responses

Response Schema: application/json

schemas	Array of strings User schemas.
id	string <guid> A unique identifier for a SCIM resource as defined by the service provider.
externalId	string A String that is an identifier for the resource as defined by the provisioning client.
	object The name of the user.
userName	string The username of the user.
displayName	string The display name of the user.
title	string The title of the user.
active	boolean The active status of the user.
preferredLanguage	string The preferred language of the user.
password	string The password of the user.
	Array of objects (EmailResponse) The emails of the user.
	Array of objects (PhoneNumberResponse) The phone numbers of the user. The SCIM User/Phones is a List of Phones, which suppose to have multiple values, whether the AbsorbUser / phone is a single value
	Array of objects (AddressResponse) The addresses of the user.
	Array of objects (GroupResponse) The user's groups.
	object The user's extended attributes.
	object The user's enterprise details.
	object Attribute containing resource metadata.

https://{rootUrl}/scim/v2/Users/{id}

Request samples

• Payload

Content type

application/json

{

• "schemas": [

  • "string"

  ],
• "Operations": [

  • {

    • "op": "string",
    • "path": "string",
    • "value": null

    }

  ]

}

Response samples

• 200
• 400
• 404
• 409

Content type

application/json

{

• "schemas": [

  • "string"

  ],
• "id": "string",
• "externalId": "string",
• "name": {

  • "givenName": "string",
  • "middleName": "string",
  • "familyName": "string"

  },
• "userName": "string",
• "displayName": "string",
• "title": "string",
• "active": true,
• "preferredLanguage": "string",
• "password": "string",
• "emails": [

  • {

    • "type": "string",
    • "primary": true,
    • "display": "string",
    • "value": "string",
    • "$ref": "http://example.com"

    }

  ],
• "phoneNumbers": [

  • {

    • "type": "string",
    • "primary": true,
    • "display": "string",
    • "value": "string",
    • "$ref": "http://example.com"

    }

  ],
• "addresses": [

  • {

    • "streetAddress": "string",
    • "locality": "string",
    • "region": "string",
    • "postalCode": "string",
    • "country": "string",
    • "type": "string",
    • "primary": true

    }

  ],
• "groups": [

  • {

    • "type": "string",
    • "primary": true,
    • "display": "string",
    • "value": "string",
    • "$ref": "http://example.com"

    }

  ],
• "urn:ietf:params:scim:schemas:extension:absorb:2.0:User": {

  • "location": "string",
  • "dateHired": "2019-08-24T14:15:22Z",
  • "gender": 0,
  • "customFields": [

    • {

      • "type": "string",
      • "display": "string",
      • "value": null

      }

    ],
  • "userManagementSettings": {

    • "isLearner": true,
    • "isAdmin": true,
    • "isReviewer": true,
    • "isManager": true,
    • "isInstructor": true,
    • "adminRoles": [

      • "string"

      ],
    • "userManagementType": 0,
    • "managerRoles": [

      • "string"

      ],
    • "mangedGroupId": "string",
    • "managedDepartments": [

      • {

        • "departmentId": "string",
        • "includeSubDepartments": true

        }

      ]

    }

  },
• "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {

  • "employeeNumber": "string",
  • "manager": {

    • "value": "string"

    }

  },
• "meta": {

  • "resourceType": "User",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "location": "http://example.com"

  }

}