Skip to main content

ApiKey Schema

Data structure for Api Key objects.

Fields​

FieldTypeRequiredDescriptionNotes
enabledbooleanNo--
idintegerYes--
key_valuestringNo-API field: key_value
last_modified_byEntityReferenceNo-API field: last_modified_by
last_modified_timeintegerNo-API field: last_modified_time
namestringYes--
partnerEntityReferenceNo--
partner_urlstringNo-API field: partner_url
permissionsPermissionsEnumCollectionNo--
smsm_keyidintegerNo--

Example​

{
"enabled": true,
"id": 123,
"key_value": "string",
"last_modified_by": {
"association_time": 123,
"deleted": true,
"extensions": {
"id": "object-id"
}
},
"last_modified_time": 123,
"name": "string",
"partner": {
"association_time": 123,
"deleted": true,
"extensions": {
"id": "object-id"
}
},
"partner_url": "string"
}
// ... more fields