643 matches
100 actions
Contract.fit
100 actions
Other/Contract.fit
API Keys are simple randomly generated strings bound to roles that grant access to resources.
Every API Key maps to attributes defining its validity and can be revoked at any time.
API Key can be passed in the X-API-Key HTTP Header and in the querystring &api_key=
Permission required: edit_backend_settings
{
"type": "object",
"properties": {
"X-Fields": {
"type": "string",
"format": "mask"
},
"active": {
"type": "boolean",
"description": "Is the API Key active or not"
},
"expire_at": {
"type": "string",
"format": "date-time",
"description": "Expiration date"
},
"roles": {
"type": "array",
"description": "Roles to grant to this token bearer",
"items": {
"type": "object",
"required": [
"role"
],
"properties": {
"document_id": {
"type": "string",
"description": "limited to a document"
},
"inbox": {
"type": "string"
},
"role": {
"type": "string"
}
}
}
},
"user": {
"type": "string",
"description": "User to give to the bearer"
}
},
"required": [
"roles",
"user"
],
"additionalProperties": false
}{
"type": "object",
"required": [
"active",
"token",
"user"
],
"properties": {
"active": {
"type": "boolean",
"description": "Is the API Key active or not"
},
"expire_at": {
"type": "string",
"format": "date-time",
"description": "The date at which the API Key will expire"
},
"roles": {
"type": "array",
"description": "the user roles",
"items": {
"type": "object",
"required": [
"role"
],
"properties": {
"document_id": {
"type": "string",
"description": "limited to a document"
},
"inbox": {
"type": "string"
},
"role": {
"type": "string"
}
}
}
},
"token": {
"type": "string",
"description": "Token value"
},
"user": {
"type": "string",
"description": "Bearer user"
}
}
}