APIs

Incoming

Add

Name – A name to describe what the key is doing.
Action – The API to give access to
Client – the name of the client, like username
Key – a string of characters that is like a password, see https://passwordsgenerator.net/ for generating one.
From Tenant – When From Tenant is selected the system will create a corresponding outgoing key in that Tenant’s outgoing list.
Start Date – The date this key has access to the system starting from, if applicable
End Date – The date this key has access to the system ending at, if applicable

Grid

Name – see Incoming > Add
Active – Whether the key is active at the moment
Action – see Incoming > Add
Client – see Incoming > Add
Key – see Incoming > Add
From Tenant – see Incoming > Add
Intra-Tenant – Whether the key is between 2 tenants or an outside service
Entity Type – The Entity that the API will use to do an action, not fully setup yet
Start – see Incoming > Add
End – see Incoming > Add
Auth – the auth string for an HTTP header, for testing purposes
Delete – allows one to delete a key, will remove corresponding key, if applicable

Outgoing

Grid

Name – see Incoming > Add
Active – Whether the key is active now.
Key – a string of characters that is like a password, see https://passwordsgenerator.net/ for generating one, will often be provided to you.
For Tenant – The tenant that this key will be used to connect to.
Intra-Tenant – Whether the key is between 2 tenants or an outside service.
Outgoing URL – the URL that this key will contact.
Start – The date this key has access to the system starting from, if applicable
End – The date this key has access to the system ending at, if applicable
Delete – allows one to delete a key, will remove corresponding key, if applicable

Access

Grid

Date – The date the access was attempted.
Success – if the access was successful.
IP Address – the IP Address the access came from
Action – the action attempter to be used.
Client – the client attempted to be used.
Key – the key attempted to be used.