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

Path parameters

namestringRequired

A valid name of organization

Responses

200

Ok

*/*

Response when search for an organization

uuidstringOptional

Organization's id

namestringOptional

Organization's name

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

/organizations/{name}

HTTPcURLJavaScriptPython

GET /organizations/{name} HTTP/1.1
Accept: */*

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

Client Credentials Managing

Creates a new client credential in keycloack following the contract below

post

Path parameters

orgUUIDstringRequired

A valid uuid of organization

Body

application/json

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

*/*

DTO response for returning data from a credential client

idstringOptional

Id of client credential

namestringRequired

Client of client credential

clientIdstringRequired

Name of client credential

secretstringOptional

The secret generate

400

Badrequest

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

/org/{orgUUID}/client-credentials

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/client-credentials HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 54

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

{
  "id": "text",
  "name": "text",
  "clientId": "text",
  "secret": "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

*/*

DTO response for returning a client credential list

idstringOptional

Id of client credential

clientIdstringRequired

Client of client credential

namestringRequired

Name of client credential

descriptionstringRequired

Description of client credential

enabledbooleanRequired

Enable status of client credential

redirectUrisstring[]Optional

Redirect URIs of client

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

/org/{orgUUID}/client-credentials

HTTPcURLJavaScriptPython

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

*/*

DTO response for returning a client credential list

idstringOptional

Id of client credential

clientIdstringRequired

Client of client credential

namestringRequired

Name of client credential

descriptionstringRequired

Description of client credential

enabledbooleanRequired

Enable status of client credential

redirectUrisstring[]Optional

Redirect URIs of client

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/client-credentials/{id} HTTP/1.1
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

*/*

DTO response for returning the regenerated secret

typestringOptional

Type of secret

valuestringOptional

The secret regenerate

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

put

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

HTTPcURLJavaScriptPython

PUT /org/{orgUUID}/client-credentials/{id}/regenerate-secret HTTP/1.1
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

No content

204

No Content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

put

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

HTTPcURLJavaScriptPython

PUT /org/{orgUUID}/client-credentials/{id}/enable-disable HTTP/1.1
Accept: */*

No content