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

200

*/*

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"
}

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

post

Body

Organization creation object

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

Responses

201

Created

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

POST /organizations HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "name": "text",
  "adminUrl": "text",
  "eventsExpiration": 1,
  "user": {
    "name": "text",
    "image": "text",
    "email": "text",
    "company": "text",
    "role": "text",
    "password": "text",
    "confirmPassword": "text"
  }
}

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

Restores an organization

put

Path parameters

orgUUIDstringRequired

A valid organization Uuid

Query parameters

userUUIDstringRequired

A valid uuid of user

Responses

204

No Content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Organization {orgUUID} not found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

put

PUT /organizations/{orgUUID}?userUUID=text HTTP/1.1
Host: 
Accept: */*

No content

Disables an organization.

delete

Path parameters

orgUUIDstringRequired

A valid organization Uuid

Query parameters

userUUIDstringRequired

A valid uuid of user

Responses

204

No Content

400

Bad request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Organization {orgUUID} not found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

delete

DELETE /organizations/{orgUUID}?userUUID=text HTTP/1.1
Host: 
Accept: */*

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

clientIdstringOptional

to fetch a particular client credential

Default: ""

Responses

200

*/*

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
  }
]

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

*/*

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
}

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

*/*

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"
}

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

*/*

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

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

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

200

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

delete

DELETE /org/{orgUUID}/client-credentials/{id} HTTP/1.1
Host: 
Accept: */*

No content

PreviousEnvironment NextUser

Was this helpful?