Organization

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

API SUBPATH: eva-organization

Per default, the eva-organization API has it's network policy blocking external access. The following documentation has Syntphony CAI server clients as their target. If you are an eva-cloud customer, the tasks performed below must be instead requested by submitting a ticket.

CRUD Methods

Finds an organization by name and retrieves it's keys.

GET/organizations/{name}

Path parameters

name*string

A valid name of organization

Response

200400401403404409422500

Ok

Body

*/*

uuidstring

Organization's id

namestring

Organization's name

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{name}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "uuid": "text",
  "name": "text"
}

Create an organization and the necessary users for the system, Admin user and Clever user

POST/organizations

Body

application/json

namestring

Organization's name

adminUrlstring

It's the DNS used to enable URL redirection, web origin and system urls

eventsExpirationinteger (int32)

It is used to set the event ttl in keycloak, during realm creation

userUserDTO (object)

Organization's default user, this will be the admin user used to create system resources.

Response

201400401403404409422500

Created

Body

*/*

uuidstring

Organization's id

namestring

Organization's name

Request

JavaScriptCurlPython

const response = await fetch('/organizations', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400401403404409422500

{
  "uuid": "text",
  "name": "text"
}

Restores an organization

PUT/organizations/{orgUUID}

Path parameters

orgUUID*string

A valid organization Uuid

Query parameters

Response

204400401403404409422500

No Content

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{orgUUID}?userUUID=text', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

{
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

Disables an organization.

DELETE/organizations/{orgUUID}

Path parameters

orgUUID*string

A valid organization Uuid

Query parameters

Response

204400401403404409422500

No Content

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{orgUUID}?userUUID=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

{
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

Client Credentials Managing

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/org/{orgUUID}/client-credentials

Path parameters

orgUUID*string

A valid uuid of organization

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

idstring

Id of client credential

clientId*string

Client of client credential

name*string

Name of client credential

description*string

Description of client credential

enabled*boolean

Enable status of client credential

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/client-credentials', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  {
    "id": "text",
    "clientId": "text",
    "name": "text",
    "description": "text",
    "enabled": false
  }
]

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

GET/org/{orgUUID}/client-credentials/{id}

Path parameters

orgUUID*string

A valid uuid of organization

id*string

A valid id of client credentials

Response

200400401403404409422500

Ok

Body

*/*

idstring

Id of client credential

clientId*string

Client of client credential

name*string

Name of client credential

description*string

Description of client credential

enabled*boolean

Enable status of client credential

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/client-credentials/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "id": "text",
  "clientId": "text",
  "name": "text",
  "description": "text",
  "enabled": false
}

Creates a new client credential in keycloack following the contract below

POST/org/{orgUUID}/client-credentials

Path parameters

orgUUID*string

A valid uuid of organization

Body

application/json

clientId*string

Client id of client credential

name*string

Name of client credential

descriptionstring

Description of the client credential

Response

200400401403404409422500

Ok

Body

*/*

idstring

Id of client credential

name*string

Client of client credential

clientId*string

Name of client credential

secretstring

The secret generate

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/client-credentials', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "clientId": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

200400401403404409422500

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

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

PUT/org/{orgUUID}/client-credentials/{id}/regenerate-secret

Path parameters

orgUUID*string

A valid uuid of organization

id*string

A valid id of client credentials

Response

200400401403404409422500

Ok

Body

*/*

typestring

Type of secret

valuestring

The secret regenerate

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/client-credentials/{id}/regenerate-secret', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "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/org/{orgUUID}/client-credentials/{id}/enable-disable

Path parameters

orgUUID*string

A valid uuid of organization

id*string

A valid id of client credentials

Response

200400401403404409422500

Ok

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/client-credentials/{id}/enable-disable', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

{
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

Deletes a keycloak client credential, matching the provided id by path parameter

DELETE/org/{orgUUID}/client-credentials/{id}

Path parameters

orgUUID*string

A valid uuid of organization

id*string

A valid id of client credentials

Response

200400401403404409422500

Ok

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/client-credentials/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

{
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}