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
- POSTRemoves a project member.
- POSTAdds a new project member.
- GETGet members of a project
- GETReads a project member.
- PATCHUpdates a project member.
- POSTAdds a new project-wide role to a user.
- POSTRemoves a role from a project-member.
- GETGet users
- POSTCreates a new user
- GETGet a user
- DELDeletes an user.
- PATCHUpdates a user.
- POSTMakes a project available to a user.
- POSTAdds a new org-wide role to an user.
- POSTPerforms a logout for a specific user.
- POSTRemoves project from a user.
- POSTRemoves an organisation-wide role from an user.
- POSTResets failed login attempts for user.
- POSTChanges the password of a user.
- POSTDeprecates a user-password / all passwords in the org.
- GETGets own user profile.
- DELDeletes the own user.
- PATCHUpdates the own user object.
- POSTAccept the Terms of Service
- GETRetrieves own ACL.
- GETGet api-keys of the current user.
- POSTCreates a new api-key for the own user.
- DELDeletes an api-key for the own user.
- GETRetrieves the last login attempt.
- GETGet login attempts of the own user.
- POSTPin/Unpin Resources
- GETGet Pinned Resources
- POSTRequest a password reset
- POSTReset the password
- POSTvalidate password reset token
- POST
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!
Users v2.0
Retrieves own ACL.
Retrieves the ACL information for the own User profile.
GET
/
v2.0
/
users
/
me
/
acl
Retrieves own ACL.
Copy
curl --request GET \
--url 'https://api-trial.cognigy.ai/new/v2.0/users/me/acl?api_key=' \
--header 'Authorization: Bearer <token>' \
--header 'X-API-Key: <api-key>'Copy
{
"organisationWide": {
"rights": {
"analyticsOdata": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"apiKeys": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"auditEvents": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"liveAgentAccount": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"projects": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"userDetails": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"users": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"connections": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"contactProfiles": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"conversationHistory": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"endpoints": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"extensions": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"flowNodeComments": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"flowNodeDescription": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"flowNodes": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"flows": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"intents": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"knowledgeStores": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"lexicons": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"liveAgentInbox": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"locales": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"logs": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"memberDetails": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"members": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"goals": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"nluConnectors": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"playbooks": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"project": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"projectSettings": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"snapshots": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"states": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"tasks": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"tokens": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"voiceGatewayAccount": {
"create": true,
"read": true,
"update": true,
"delete": true
}
},
"roles": [
"admin"
]
},
"projectWide": {}
}Authorizations
Supply the API Key in the HTTP-Header
Supply the API Key in the Url-Query
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
The default media type is application/hal+json. Use application/json for pure data results.
Available options:
application/json, application/hal+json, application/xml, text/xml, text/csv Response
Returns the acl object for the user.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
admin, apiKeys, base_role, basicSupportUser, fullSupportUser, liveAgentAdmin, liveAgentAgent, liveAgentSupervisor, odata, projectAssigner, projectManager, userManager, userDetailsViewer, voiceGatewayUser, opsCenterUser Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
agentAssistConfigAdmin, agentAssistConfigViewer, analytics, basic, connection_admin, contact_profile_admin, contact_profile_editor, contact_profile_viewer, conversationHistory, developer, endpoint_admin, extension_admin, extension_editor, flowEditor, flowNodeComments, flowNodeDescriptions, followUser, handoverProviderAdmin, intents, data_privacy_admin, data_privacy_editor, data_privacy_viewer, knowledgeAdmin, large_language_model_admin,, lexicon_admin, lexicon_editor, localesAdmin, logs, memberManager, nlu_connector_admin, packages_admin, playbook_admin, playbook_editor, projectAdmin, snapshot_admin, tokenAdmin, tokenEditor, function_admin, function_editor, simulator_admin Previous
Get api-keys of the current user.Get 25 api-keys of the current user by default. To change the default value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.
Next
⌘I
Retrieves own ACL.
Copy
curl --request GET \
--url 'https://api-trial.cognigy.ai/new/v2.0/users/me/acl?api_key=' \
--header 'Authorization: Bearer <token>' \
--header 'X-API-Key: <api-key>'Copy
{
"organisationWide": {
"rights": {
"analyticsOdata": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"apiKeys": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"auditEvents": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"liveAgentAccount": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"projects": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"userDetails": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"users": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"connections": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"contactProfiles": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"conversationHistory": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"endpoints": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"extensions": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"flowNodeComments": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"flowNodeDescription": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"flowNodes": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"flows": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"intents": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"knowledgeStores": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"lexicons": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"liveAgentInbox": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"locales": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"logs": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"memberDetails": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"members": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"goals": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"nluConnectors": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"playbooks": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"project": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"projectSettings": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"snapshots": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"states": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"tasks": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"tokens": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"voiceGatewayAccount": {
"create": true,
"read": true,
"update": true,
"delete": true
}
},
"roles": [
"admin"
]
},
"projectWide": {}
}