User Guide
API DOCSVOICE GATEWAYHELPSECURITY
Current Version
Current Version
  • Welcome
  • What's New
  • 🚀GETTING STARTED
    • Login
    • Concepts and Glossary
    • Language Models
      • Syntphony NLP
      • Other NLP and LLM Connectors
      • FAQs
    • Build a Virtual Agent
      • Overview
      • From Scratch
      • By Importing
      • Pre-Built Templates
      • Training task
    • Testing
      • Automated Test
      • Advanced Request
      • Simulate Dialog
      • View Logs
    • Create and manage profiles
  • 💬BUILD DIALOGS
    • Flows
    • Dialog Cells
      • Intent
      • Entity
      • Answer
      • Input
      • Jump
      • End
      • Service
      • Rest Connector
      • Code
      • Rule
        • Variable answers using Code and Rule cells
        • Enable and disable flows using Rule Cells
    • Data Masking of Personal Identificable Information
    • Dynamic Content and Contexts
    • Voice Agent
    • Multilingual Agent (beta)
  • ✨GENERATIVE AI
    • AI features
    • Assist Answer (beta)
    • Examples Generator
    • Knowledge AI
    • Prompt cell
      • Prompt crafting
      • Practical examples
    • Rephrase Answer
    • Zero-Shot LLM
  • 🌐CHANNELS
    • Channels
      • WhatsApp (by Infobip)
      • Facebook Messenger
      • Microsoft Teams
      • Integrating Existing Channels
    • Webchat Plugin
  • ⚙️CONFIGURATIONS
    • Parameters
    • Advanced Resources
    • Other Options
      • Intent Navigator
  • 📊ANALYTICS & INSIGHTS
    • Dashboards
      • Overview
      • Funnel charts
      • User messages
      • Conversations
      • Reports
    • External Analytics Platforms
  • API DOCS
    • Overview
    • API Guidelines
      • Conversation API
      • Cloner API
      • EVG Connector
      • Management API
        • Admin API
          • Bot Admin
          • Environment
          • Organization
          • User
          • Notification
        • Instance API
          • Knowledge AI
          • Knowledge AI NLP
          • Answer
          • Automated Tests
          • Bot
          • Broker
          • Channel
          • Dashboard
          • Dialog Manager
          • Entity
          • Generative Service
          • Intent
          • Parameters
          • Tag
          • Technical Log
          • Training
          • Transactional Service
          • Rest Connector
          • Wait Input
          • Websnippet
      • Webhooks
    • Infrastructure Guidelines
      • Syntphony CAI server Installation guide
      • Maintenance Methods
      • Supported/verified third-party software
    • Data Structure
      • Admin Data Structure
      • Environment Data Structure
    • Voice Gateway
      • Genesys Cloud CX
Powered by GitBook
On this page

Was this helpful?

  1. API DOCS
  2. API Guidelines
  3. Management API
  4. Admin API

Organization

The Organization API helps you acquire information from your organizations, and your client credentials.

PreviousEnvironmentNextUser

Last updated 5 months ago

Was this helpful?

API SUBPATH: eva-organization

CRUD Methods

Client Credentials Managing

Find an organization by name

get
Path parameters
namestringRequired

A valid name of organization

Responses
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /organizations/{name} HTTP/1.1
Host: 
Accept: */*
{
  "uuid": "text",
  "name": "text"
}

Lists the client credentials created in the keycloak. When passing an optional clientId Query String, the client credential list will be filtered to match the provided clientId.

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

Query parameters
clientIdstringOptional

to fetch a particular client credential

Default: ""
Responses
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/client-credentials HTTP/1.1
Host: 
Accept: */*
[
  {
    "id": "text",
    "clientId": "text",
    "name": "text",
    "description": "text",
    "enabled": true,
    "redirectUris": [
      "text"
    ]
  }
]

Retrieves a client credential’s full data, matching the provided id by path parameter

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

idstringRequired

A valid id of client credentials

Responses
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/client-credentials/{id} HTTP/1.1
Host: 
Accept: */*
{
  "id": "text",
  "clientId": "text",
  "name": "text",
  "description": "text",
  "enabled": true,
  "redirectUris": [
    "text"
  ]
}

Generates a new secret for the provided client credentials, immediately revoking the previous secret key.

put
Path parameters
orgUUIDstringRequired

A valid uuid of organization

idstringRequired

A valid id of client credentials

Responses
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
put
PUT /org/{orgUUID}/client-credentials/{id}/regenerate-secret HTTP/1.1
Host: 
Accept: */*
{
  "type": "text",
  "value": "text"
}

Immediately alternates whether a client credencial key is enabled or not. The current status can be acquired by the Details endpoint.

put
Path parameters
orgUUIDstringRequired

A valid uuid of organization

idstringRequired

A valid id of client credentials

Responses
200
Ok
204
No Content
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
put
PUT /org/{orgUUID}/client-credentials/{id}/enable-disable HTTP/1.1
Host: 
Accept: */*

No content

  • CRUD Methods
  • GETFind an organization by name
  • Client Credentials Managing
  • POSTCreates a new client credential in keycloack following the contract below
  • GETLists the client credentials created in the keycloak. When passing an optional clientId Query String, the client credential list will be filtered to match the provided clientId.
  • GETRetrieves a client credential’s full data, matching the provided id by path parameter
  • PUTGenerates a new secret for the provided client credentials, immediately revoking the previous secret key.
  • PUTImmediately alternates whether a client credencial key is enabled or not. The current status can be acquired by the Details endpoint.

Creates a new client credential in keycloack following the contract below

post
Path parameters
orgUUIDstringRequired

A valid uuid of organization

Body

DTO with client credentials data

clientIdstringRequired

Client id of client credential

namestringRequired

Name of client credential

descriptionstringOptional

Description of the client credential

Responses
200
Ok
*/*
400
Badrequest
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/client-credentials HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "clientId": "text",
  "name": "text",
  "description": "text"
}
{
  "id": "text",
  "name": "text",
  "clientId": "text",
  "secret": "text"
}