POST /apiv2/identities/linkIdentitiesToCompanies
Assign companies and roles to identities to give them access to the system. You must be an administrator of the organisation in question to be able to access this endpoint.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 |
|---|---|---|---|
links[] |
Array | No |
One or more identities to provision access for |
links[].identityId |
Integer | No |
The ID in MachShip of an identity owned by your Organisation. Either the IdentityId, IdentityPublicKey or IdentityClaimName must be provided |
links[].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 Valid values:
|
links[].companyId |
Integer | Yes |
The ID in MachShip of a company within your organisation |
links[].roles[] |
Array | Yes |
One ore more role IDs to assign the identity |
links[].identityPublicKey |
String | No |
The "public key" of an identity from another organisation (who has been linked to your organisation). Either the IdentityId, IdentityPublicKey or IdentityClaimName must be provided |
links[].identityClaim |
String | No |
The "identity claim" (usually email) of an identity from another organisation (who has been linked to your organisation). Either the IdentityId, IdentityPublicKey or IdentityClaimName must be provided |
links[].identityLinkType |
Integer | No |
0 = Unknown, 1 = IdentityId, 2 = IdentityPublicKey, 3 = IdentityClaimName Valid values:
|
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.