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
- POSTRemove a Project Member
- POSTAdd a Project Member
- GETGet Project Members
- GETGet a Project Member
- PATCHUpdate a Project Member
- POSTAssign a Project Role
- POSTUnassign a Project Role
- GETGet Users
- POSTCreate a User
- GETGet a User
- DELDelete a User
- PATCHUpdate a User Profile
- POSTAssign a Project to a User
- POSTAssign a Global Role
- POSTLog Out a User
- POSTUnassign a Project from a User
- POSTUnassign a Global Role
- POSTReset Failed Login Attempts
- POSTChange a User Password
- POSTDeprecate User Passwords
- GETGets the Current User's Profile
- DELDelete Own User
- PATCHUpdate Own User
- POSTAccept the Terms of Service
- GETGet Current User's ACL
- GETGet API Keys of the Current User
- POSTCreate an API Key
- DELDelete an API Key
- GETGet the Last Login Attempt
- GETGet Login Attempts of the Current User
- POSTPin or Unpin Resources
- GETGet Pinned Resources
- POSTRequest a Password Reset
- POSTReset a User Password
- POSTValidate a Password Reset Token
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 all the information from a user.
curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/users/{userId} \
--header 'X-API-Key: <api-key>'{
"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
Supply the API Key in the HTTP-Header
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/v2.0/users/{userId} \
--header 'X-API-Key: <api-key>'{
"id": "<string>",
"name": "<string>",
"organisation": "<string>",
"roles": [
"admin"
],
"projects": [
"<string>"
],
"acceptedTOS": true,
"disabled": true,
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}