POST /apiv2/identities/createIdentities
Servers
- /
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
[] |
Array | Yes | |
[].testModeSetting |
Integer | No |
Indicator of a MachShip user's settings in relation to viewing "test" data in the live system - eg test consignments, manifests, accounts0 = Disabled, 1 = Enabled, 2 = UserIsInTestMode Possible values:
|
[].owningCompanyId |
Integer | Yes | |
[].userType |
Integer | No |
1 = SystemAdmin, 2 = User, 3 = Broker, 4 = Reseller, 5 = System, 6 = Enterprise Possible values:
|
[].emailAddress |
String | Yes | |
[].displayName |
String | Yes | |
[].position |
String | No | |
[].enableEmailNotifications |
Boolean | No | |
[].givenName |
String | Yes | |
[].uniqueId |
String | No | |
[].notes |
String | No | |
[].userAndCompanyLinks[] |
Array | No | |
[].userAndCompanyLinks[].companyId |
Integer | Yes | |
[].userAndCompanyLinks[].roles[] |
Array | Yes | |
[].identifyingClaim |
String | Yes | |
[].businessPhone |
String | No | |
[].phone |
String | No | |
[].password |
String | No | |
[].identityProviderId |
Integer | Yes | |
[].familyName |
String | Yes | |
[].organisationId |
Integer | Yes | |
[].mobile |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.