Organization

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

API SUBPATH: eva-organization

CRUD Methods

Find an organization by name

get

/organizations/{name}

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

Client Credentials Managing

Creates a new client credential in keycloack following the contract below

post

/org/{orgUUID}/client-credentials

Path parameters

orgUUIDstringrequired

A valid uuid of organization

Body

clientIdstringrequired

Client id of client credential

namestringrequired

Name of client credential

descriptionstring

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

200

400

401

403

404

409

422

500

200

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

Ok

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

orgUUIDstringrequired

A valid uuid of organization

Query parameters

clientIdstring

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,
    "redirectUris": [
      "text"
    ]
  }
]

Ok

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

get

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

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,
  "redirectUris": [
    "text"
  ]
}

Ok

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

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

/org/{orgUUID}/client-credentials/{id}/enable-disable

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

204

400

401

403

404

409

422

500

200

No body

Ok