Organization
The Organization API helps you acquire information from your organizations, and your client credentials.
CRUD Methods
A valid name of organization
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /organizations/{name} HTTP/1.1
Host:
Accept: */*
{
"uuid": "text",
"name": "text"
}
Organization creation object
Organization's name
It's the DNS used to enable URL redirection, web origin and system urls
It is used to set the event ttl in keycloak, during realm creation
Created
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
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"
}
A valid organization Uuid
A valid uuid of user
No Content
No content
Bad Request
Unauthorized
Forbidden
Organization {orgUUID} not found
Conflict
Unprocessable Entity
Internal Server Error
PUT /organizations/{orgUUID}?userUUID=text HTTP/1.1
Host:
Accept: */*
No content
A valid organization Uuid
A valid uuid of user
No Content
No content
Bad request
Unauthorized
Forbidden
Organization {orgUUID} not found
Conflict
Unprocessable Entity
Internal Server Error
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.
A valid uuid of organization
to fetch a particular client credential
""
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /org/{orgUUID}/client-credentials HTTP/1.1
Host:
Accept: */*
[
{
"id": "text",
"clientId": "text",
"name": "text",
"description": "text",
"enabled": true
}
]
A valid uuid of organization
A valid id of client credentials
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /org/{orgUUID}/client-credentials/{id} HTTP/1.1
Host:
Accept: */*
{
"id": "text",
"clientId": "text",
"name": "text",
"description": "text",
"enabled": true
}
A valid uuid of organization
DTO with client credentials data
Client id of client credential
Name of client credential
Description of the client credential
Ok
Badrequest
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
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.
A valid uuid of organization
A valid id of client credentials
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
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.
A valid uuid of organization
A valid id of client credentials
Ok
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
PUT /org/{orgUUID}/client-credentials/{id}/enable-disable HTTP/1.1
Host:
Accept: */*
No content
A valid uuid of organization
A valid id of client credentials
Ok
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
DELETE /org/{orgUUID}/client-credentials/{id} HTTP/1.1
Host:
Accept: */*
No content
Was this helpful?