Create a User

Prerequisites:

  • You have the Subscription Key and Account Key that are needed for authentication. If you need these, speak with your IntelAgree Account Manager or Implementation Manager.

  • You have a valid authentication token

Please see the Getting Started page for more information about how to obtain an authentication token, as well as a description of Business Keys and Impersonation, which are used when you create a Party. You can also download a Postman file from that page, which contains this and all other API operations so that you can test them.

Create User

To create a Party, you will call the POST /users operation with the following information:

Headers:

  • "ApiVersion": "2.0", Required to specifiy version 2 of the API.

  • "Ocp-Apim-Subscription-Key": Your subscription key. Required for all calls to the API

  • "Authorization": Your authorization Bearer token. Required for all authenticated calls to the API.

  • "AsUserType": Optional. The BusinessKeyType for the user that is creating the new user. If not provided, your API User will be the creater of the new user

  • "AsUserKey": Optional. The BusinessKey Value for the user that is creating the new user. If not provided, your API User will be the creater of the new user

Request Body:

  • "name": Required string. The name of the user

  • "legalName": Required string. The user's legal name

  • "email": Required string. The user's email address

  • "title": Optional string. The user's job title

  • "businessKeys": Optional. A list of one or more businessKeys that can be used to identify the user

  • "userPermissions": Optional. A list of permissions to apply to the user

  • "permissionPresets": Optional. A list of permission presets to apply to the user

  • "userPermissionsToClone": Optional. The BusinessKey of a user whose permissions should be cloned in the new user

  • "hasAllOrganizations": Optional. If true, the permissions specified will apply to all IntelAgree organizations

  • "primaryLegalEntityId": Optional integer. The ID of the primary Legal Entity to associate with the user