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 eva 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

Path parameters

namestringrequired

A valid name of organization

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/organizations/{name}'

200

400

401

403

404

409

422

500

200

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

Ok

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

post

Body

namestringoptional

Organization's name

adminUrlstringoptional

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

eventsExpirationinteger · int32optional

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

userobjectoptional

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/organizations' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "adminUrl": "text",
    "eventsExpiration": 1,
    "user": {
      "name": "text",
      "image": "text",
      "email": "text",
      "company": "text",
      "role": "text",
      "password": "text",
      "confirmPassword": "text"
    }
  }'

201

400

401

403

404

409

422

500

201

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

Created

Restores an organization

put

Path parameters

orgUUIDstringrequired

A valid organization Uuid

Query parameters

userUUIDstringrequired

A valid uuid of user

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/organizations/{orgUUID}?userUUID=text'

204

400

401

403

404

409

422

500

204

No body

No Content

Disables an organization.

delete

Path parameters

orgUUIDstringrequired

A valid organization Uuid

Query parameters

userUUIDstringrequired

A valid uuid of user

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/organizations/{orgUUID}?userUUID=text'

204

400

401

403

404

409

422

500

204

No body

No Content

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

Path parameters

orgUUIDstringrequired

A valid uuid of organization

Query parameters

clientIdstring · default: ""optional

to fetch a particular client credential

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/client-credentials'

200

400

401

403

404

409

422

500

200

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

Ok

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

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/client-credentials/{id}'

200

400

401

403

404

409

422

500

200

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

Ok

Creates a new client credential in keycloack following the contract below

post

Path parameters

orgUUIDstringrequired

A valid uuid of organization

Body

clientIdstringrequired

Client id of client credential

namestringrequired

Name of client credential

descriptionstringoptional

Description of the client credential

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/client-credentials' \
  --header 'Content-Type: application/json' \
  --data '{
    "clientId": "text",
    "name": "text",
    "description": "text"
  }'

200

400

401

403

404

409

422

500

200

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

Ok

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

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/client-credentials/{id}/regenerate-secret'

200

400

401

403

404

409

422

500

200

{
  "type": "text",
  "value": "text"
}

Ok

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

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/client-credentials/{id}/enable-disable'

200

400

401

403

404

409

422

500

200

No body

Ok

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

delete

Path parameters

orgUUIDstringrequired

A valid uuid of organization

idstringrequired

A valid id of client credentials

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/client-credentials/{id}'

200

400

401

403

404

409

422

500

200

No body

Ok