Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Overview
API
- GETGet Billing Information
- GETGet Organizations
- POSTCreate an Organization
- GETGet an Organization
- DELDelete an Organization
- PATCHUpdate an Organization
- POSTCreate an API Key
- POSTEnforce Password Policy
- POSTCreate a System Message
- GETGet Users
- POSTCreate a User
- GETGet a User
- DELDelete a User
- PATCHUpdate a User
- POSTImpersonate a User
- GETGet Vendor Information
- GETGet Billing Information
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Get a User
Gets information about a user.
curl --request GET \
--url https://api-trial.cognigy.ai/new/management/v2.0/users/{userId} \
--header 'Authorization: Basic <encoded-value>'{
"id": "<string>",
"name": "<string>",
"organisation": "<string>",
"roles": [
"admin"
],
"projects": [
"<string>"
],
"acceptedTOS": true,
"disabled": true,
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Basic Authentication used by routes designed for the Management-UI.
Headers
The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.
application/json, application/hal+json, application/xml, text/xml, text/csv Path Parameters
The Id of the User
24^[a-z0-9]{24}$Response
Returns User object
The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.
24^[a-z0-9]{24}$admin, apiKeys, base_role, basicSupportUser, fullSupportUser, liveAgentAdmin, liveAgentAgent, liveAgentSupervisor, odata, projectAssigner, projectManager, userManager, userDetailsViewer, voiceGatewayUser, opsCenterUser 24^[a-z0-9]{24}$Unix-timestamp
0 <= x <= 21474836471694518620
Unix-timestamp
0 <= x <= 21474836471694518620
24^[a-z0-9]{24}$24^[a-z0-9]{24}$curl --request GET \
--url https://api-trial.cognigy.ai/new/management/v2.0/users/{userId} \
--header 'Authorization: Basic <encoded-value>'{
"id": "<string>",
"name": "<string>",
"organisation": "<string>",
"roles": [
"admin"
],
"projects": [
"<string>"
],
"acceptedTOS": true,
"disabled": true,
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}