The SafetyCulture API gives you the ability to manage users, permission sets, and user metadata (attributes).
Users
A user is the core identifier in a SafetyCulture organization. The API allows list, add, update, and delete actions on users.
Permission sets
A permission set is a collection of permissions that can be assigned to a user. The API allows assign, get, and list actions on permission sets.
User metadata (attributes)
A user field is where users can create metadata (attributes) for their users. For example, a user can create a field called Department and assign an attribute value to it for a user.
The user can then have this made available on their user profile and be given the option to update it themselves. The API allows create, update, delete, list, disable, and restore actions on user fields.
{
"id": "0c2100df-3206-4d41-bc08-2c960233114e",
"data_type": "FIELD_VALUE_TYPE_STRING",
"name": "Department",
"description": "The department the user belongs to",
"has_attribute": true,
"status": "FIELD_STATUS_ENABLED",
"settings": {
"show_on_profile": true,
"allow_self_update": false
}
}
User attributes
A user attribute is the value of a user field for a given user. The API allows get and set actions on user attributes.
{
"field_id": "0c2100df-3206-4d41-bc08-2c960233114e",
"attribute_values": [{
"string_value": "Engineering"
}],
"field_name": "Department",
"value_type": "FIELD_VALUE_TYPE_STRING"
}