Get Hoxhunt's SCIM schema
GET https://app.hoxhunt.com/services/scim/schemas
Authorization: Bearer <your_scim_token>
Get all users
GET https://app.hoxhunt.com/services/scim/Users
Get a user
GET https://app.hoxhunt.com/services/scim/Users/*HoxhuntUserIDHere*
GET https://app.hoxhunt.com/services/scim/Users/?filter=userName eq "tony.iommi@hoxhunt.com"
GET https://app.hoxhunt.com/services/scim/Users/?filter=emails%5Btype%20eq%20%22work%22%5D.value%20 eq "tony.iommi@hoxhunt.com"
Create user
POST https://app.hoxhunt.com/services/scim/Users
Content-Type: application/scim+json
Authorization: Bearer YOUR_SCIM_TOKEN
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"userName": "tony.iommi@hoxhunt.com",
"name": {
"familyName": "Tony",
"givenName": "Iommi"
},
"emails": [
{
"value": "tony.iommi@hoxhunt.com",
"type": "work",
"primary": true
}
],
"active": true,
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"department": "Metal shear",
"division": "Sheet-metal factory"
},
"addresses": [
{
"country": "England",
"type": "work"
}
]
}
Update user
PATCH https://app.hoxhunt.com/services/scim/Users/*HoxhuntUserIDHere*
Content-Type: application/scim+json
Authorization: Bearer YOUR_SCIM_TOKEN
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "Replace",
"path": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department",
"value": "Sales
}
]
}
Deactivate/activate user
PATCH https://app.hoxhunt.com/services/scim/Users/*HoxhuntUserIDHere*
Content-Type: application/scim+json
Authorization: Bearer YOUR_SCIM_TOKEN
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "Replace",
"path": "active",
"value": true
}
]
}
Useful links
Was this article helpful?
2 out of 2 found this helpful
Have more questions? Submit a request