Hook only supports SCIM provisioning for user accesses, you cannot create or delete users via this method. User access includes user roles (manager, member, technical admin, viewer) and management hierarchy. Creating and deleting users can be managed using Hook user admin settings or automatically where employee data is stored.
SCIM Version: 2
SCIM connector Base URL: https://scim.hook.co/v2/[customer_name]/
Unique Identifier for users: id
Supported provisioning actions: [Push profile updates, Push groups]
Authentication mode: HTTP Header
The attributes are available from the schemas endpoints but here is the response. Please note you will have to set up the mapping of Hook attributes to yours.
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"totalResults": 1,
"Resources": [
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"id": "urn:ietf:params:scim:schemas:core:2.0:User",
"name": "User",
"description": "The resource schema for representing users.",
"attributes": [
{
"name": "id",
"type": "number",
"multiValued": false,
"required": true,
"mutability": "readOnly",
"returned": "always",
"description": "Unique identifier for the resource"
},
{
"name": "email",
"type": "string",
"multiValued": false,
"required": true,
"mutability": "readOnly",
"returned": "always",
"description": "The email address of the user."
},
{
"name": "userName",
"type": "string",
"multiValued": false,
"required": true,
"mutability": "readOnly",
"returned": "always",
"description": "Unique identifier for the resource"
},
{
"name": "managerEmail",
"type": "string",
"multiValued": false,
"required": false,
"mutability": "readWrite",
"returned": "always",
"description": "The email address of the users manager (or null)"
},
{
"name": "role",
"type": "string",
"multiValued": false,
"required": true,
"mutability": "readWrite",
"returned": "default",
"description": "The role assigned to the user.",
"canonicalValues": [
"technical_admin",
"admin",
"manager",
"member",
"viewer"
]
},
{
"name": "accountAccessRights",
"type": "string",
"multiValued": false,
"required": true,
"mutability": "readWrite",
"returned": "default",
"description": "The account access rights assigned to the user.",
"canonicalValues": [
"all",
"team",
"mine"
]
},
{
"name": "active",
"type": "boolean",
"multiValued": false,
"required": true,
"mutability": "readWrite",
"returned": "default",
"description": "Indicates whether the user is active in Hook."
}
],
"meta": {
"resourceType": "Schema",
"location": "https://scim.hook.co/v2/[customer_name]/Schemas/urn:ietf:params:scim:schemas:core:2.0:User"
}
}
]
}