Authentication Tokens
Create, Read, Update and Delete Authentication key tokens for contacts.
Permissions
Requires System-Admin
or Company-Admin
permissions.
command 'create'
Path: /rest/ops/create/
Create a new auth-key token
{
"type": "authinfo",
"values":{
"contact_id": contact-id-to-add-key,
"type": "auth",
"subtype": "key",
"token": "long-and-secure-auth-key-token-string"
}
}
For example:
{
"type":"authinfo",
"values":{
"contact_id": 123
"type": "auth",
"subtype": "key",
"token": "VHUSAIbicp-asi9pbhucp909gb88s78bt7csbt7os"
}
}
command 'read'
Path: /rest/ops/read/
Read existing auth-key token(s), note that if no columns are specified, all are returned.
{
"type":"authinfo",
"columns":["columns", "to", "return", ...],
"scope":{
"column": value-to-match,
...
}
}
For example:
{
"type":"authinfo",
"columns":["token"],
"scope":{
"contact_id": 123,
"type": "auth",
"subtype": "key",
}
}
command 'update'
Path: /rest/ops/update/
Update auth-key token(s), this combines scope
from a read and values
from a create to cause an update.
{
"type": "authinfo",
"scope":{
"column": value-to-match,
...
},
"values":{
"contact_id": contact-id-to-add-key,
"type": "auth",
"subtype": "key",
"token": "long-and-secure-auth-key-token-string"
}
}
For example:
{
"type":"authinfo",
"scope":{
"contact_id": 123,
"type": "auth",
"subtype": "key",
},
"values":{
"token": "VHUSAIbicp-asi9pbhucp909gb88s78bt7csbt7os"
}
}
command 'delete'
Path: /rest/ops/delete/
Delete auth-key token(s)
{
"type":"authinfo",
"scope":{
"column": value-to-match,
...
}
}
For example:
{
"type":"authinfo",
"scope":{
"contact_id": 123,
"type": "auth",
"subtype": "key"
}
}