User - Overview

A User ddddd

Methods

The API supports the following methods for User resources:

• POST - Create / Update
  • Insert or updates a User by requiring (and matching on) an internal_user_id (ie; the ID of the object on your internal system).
• POST - Activate
  • Activate a User by requiring (and matching on) an internal_user_id (ie; the ID of the object on your internal system).
• POST - Deactivate
  • Deactivate a User's access to an Account by requiring (and matching on) an internal_user_id (ie; the ID of the object on your internal system).

Resource Representation

This returns all Account memberships - even those that have been archived (see "user_status" in each account_access object).

The following JSON structure shows the format of a User resource:

{
    "id": integer,
    "created_at": string (RFC 3339 Format - 2022-05-03T17:13:44Z),
    "updated_at": string (RFC 3339 Format - 2022-05-03T17:13:44Z),
    "internal_user_id": string,
    "first_name":"Jane",
    "last_name":"Shaw",
    "email":"[email protected]",
    "company_name":"Big Industries Inc.",
    "account_access": [
        {
            "id": integer,
            "account_id": integer,
            "internal_account_id":"child_account_1893",
            "user_permission_group_id":450,
            "user_status":"active"
        },
        {
            "id": integer,
            "account_id": integer,
            "internal_account_id":"child_account_1899",
            "user_permission_group_id":450,
            "user_status":"active"
        }
    ]
}

Resource Properties

The following table defines the properties that appear in this resource:

Key	Type	Definition
id	integer	The ID of the User.
created_at	string	The date and time that the User was created. The value is specified in RFC 3339 Format (2022-05-03T17:13:44Z).
updated_at	string	The date and time that the User was last updated. The value is specified in RFC 3339 Format (2022-05-03T17:13:44Z).
id	integer	The ID of the Incentify account.
email	string	The email of the user (used as the unique identifier).
first_name	string	First Name of the User.
last_name	string	Last Name of the User.
company_name	string	The name of the company the user is affiliated with.