Organization
The Organization API helps you acquire information from your organizations, and your client credentials.
CRUD Methods
Path parameters
namestringRequired
A valid name of organization
Responses
200
Ok
*/*
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"
}
Client Credentials Managing
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
Ok
*/*
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"
}
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
clientIdstringOptionalDefault:
to fetch a particular client credential
""
Responses
200
Ok
*/*
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,
"redirectUris": [
"text"
]
}
]
Path parameters
orgUUIDstringRequired
A valid uuid of organization
idstringRequired
A valid id of client credentials
Responses
200
Ok
*/*
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,
"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
*/*
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
Ok
204
No Content
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
Last updated
Was this helpful?