Local API (2.19.0)
Download OpenAPI specification:Download
REST API for local administration operations without authentication
Create Administrator
Request Body schema: application/jsonrequired
| description | string Description of the user |
| firstName | string First name of the user |
| lastName | string Last name of the user |
string <email> Email of the user | |
| groupUuids | Array of strings Groups UUIDs of the user. For creation, omit or provide an empty list for no group membership. For updates, omit to leave the current membership unchanged; set to an empty list to remove the user from all groups. |
| certificateData | string Base64 content of the user certificate |
| certificateUuid | string UUID of the existing certificate in the inventory. Mandatory if certificate data is not provided |
Array of objects (RequestAttribute) List of Custom Attributes | |
Array of objects (RequestAttribute) List of Custom Attributes set for the user certificate, if a new certificate is uploaded. Ignored if the certificate already exists in the inventory (matched by UUID or fingerprint). | |
| username required | string non-empty Username of the user |
| enabled | boolean Status of the user. True = Enabled, False = Disabled |
| name | string |
Responses
Request samples
- Payload
{- "description": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "groupUuids": [
- "string"
], - "certificateData": "string",
- "certificateUuid": "string",
- "customAttributes": [
- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
], - "version": "v2"
}
], - "certificateCustomAttributes": [
- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
], - "version": "v2"
}
], - "username": "user1",
- "enabled": true,
- "name": "string"
}Response samples
- 200
- 400
- 404
{- "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
- "username": "user1",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "description": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "enabled": true,
- "systemUser": true,
- "certificate": {
- "uuid": "string",
- "fingerprint": "string"
}, - "roles": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "systemRole": true
}
], - "customAttributes": [
- {
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "version": "v2"
}
]
}