Skip to content
Kong Docs are moving soon! Our docs are migrating to a new home. You'll be automatically redirected to the new site in the future. In the meantime, view this page on the new site!
|

Retrieve roles associated with a specific group

get
{protocol}://{hostname}:{port}{path}/workspace_/groups/{groups}/roles

Path Parameters

groupsstringrequired

Response

200 application/json

Successfully retrieved the roles

groupobject
Show Child Parameters
rbac_roleobject
Show Child Parameters
workspaceobject
Show Child Parameters
get/workspace_/groups/{groups}/roles
 
200 application/json

Associate a role with a group

post
{protocol}://{hostname}:{port}{path}/workspace_/groups/{groups}/roles

Path Parameters

groupsstringrequired

Body

application/json
rbac_role_idstringrequired
workspace_idstringrequired

Response

201 application/json

Successfully associated the role with the group

groupobject
Show Child Parameters
rbac_roleobject
Show Child Parameters
workspaceobject
Show Child Parameters
post/workspace_/groups/{groups}/roles

Body

{
"rbac_role_id": "rbac_role_id",
"workspace_id": "workspace_id"
}
 
201 application/json

List licenses

List active licenses. The data planes use the most recent updated_at license.

get
{protocol}://{hostname}:{port}{path}/licenses

Response

application/json

The license response object.

created_atinteger

Example:1500508800

idstring

The UUID of the license

Example:30b4edb7-0847-4f65-af90-efbed8b0161f

payloadstring

The Kong Gateway license in JSON format.

Example:{\"license\":{\"payload\":{\"admin_seats\":\"1\",\"customer\":\"Example Company, Inc\",\"dataplanes\":\"1\",\"license_creation_date\":\"2017-07-20\",\"license_expiration_date\":\"2017-07-21\",\"license_key\":\"00141000017ODj3AAG_a1V41000004wT0OEAU\",\"product_subscription\":\"Konnect Enterprise\",\"support_plan\":\"None\"},\"signature\":\"24cc21223633044c15c300be19cacc26ccc5aca0dd9a12df8a7324a1970fe304bc07b8dcd7fb08d7b92e04169313377ae3b550ead653b951bc44cd2eb59f6beb\",\"version\":\"1\"}}

updated_atinteger

Example:1500508800

get/licenses
 
application/json

Add a license

Create a license using an auto-generated UUID. When using POST, if the request payload does contain a valid Kong Gateway license, the license will be added.

If the request payload does not contain a valid licence, a 400 BAD REQUEST will be returned.

post
{protocol}://{hostname}:{port}{path}/licenses

Body

application/json

The request body for uploading a license.

payloadstring

The Kong Gateway license in JSON format.

Example:{\"license\":{\"payload\":{\"admin_seats\":\"1\",\"customer\":\"Example Company, Inc\",\"dataplanes\":\"1\",\"license_creation_date\":\"2017-07-20\",\"license_expiration_date\":\"2017-07-20\",\"license_key\":\"00141000017ODj3AAG_a1V41000004wT0OEAU\",\"product_subscription\":\"Konnect Enterprise\",\"support_plan\":\"None\"},\"signature\":\"6985968131533a967fcc721244a979948b1066967f1e9cd65dbd8eeabe060fc32d894a2945f5e4a03c1cd2198c74e058ac63d28b045c2f1fcec95877bd790e1b\",\"version\":\"1\"}}

Response

application/json

The license response object.

created_atinteger

Example:1500508800

idstring

The UUID of the license

Example:30b4edb7-0847-4f65-af90-efbed8b0161f

payloadstring

The Kong Gateway license in JSON format.

Example:{\"license\":{\"payload\":{\"admin_seats\":\"1\",\"customer\":\"Example Company, Inc\",\"dataplanes\":\"1\",\"license_creation_date\":\"2017-07-20\",\"license_expiration_date\":\"2017-07-21\",\"license_key\":\"00141000017ODj3AAG_a1V41000004wT0OEAU\",\"product_subscription\":\"Konnect Enterprise\",\"support_plan\":\"None\"},\"signature\":\"24cc21223633044c15c300be19cacc26ccc5aca0dd9a12df8a7324a1970fe304bc07b8dcd7fb08d7b92e04169313377ae3b550ead653b951bc44cd2eb59f6beb\",\"version\":\"1\"}}

updated_atinteger

Example:1500508800

post/licenses

Body

{
"payload": "{\\\"license\\\":{\\\"payload\\\":{\\\"admin_seats\\\":\\\"1\\\",\\\"customer\\\":\\\"Example Company, Inc\\\",\\\"dataplanes\\\":\\\"1\\\",\\\"license_creation_date\\\":\\\"2017-07-20\\\",\\\"license_expiration_date\\\":\\\"2017-07-20\\\",\\\"license_key\\\":\\\"00141000017ODj3AAG_a1V41000004wT0OEAU\\\",\\\"product_subscription\\\":\\\"Konnect Enterprise\\\",\\\"support_plan\\\":\\\"None\\\"},\\\"signature\\\":\\\"6985968131533a967fcc721244a979948b1066967f1e9cd65dbd8eeabe060fc32d894a2945f5e4a03c1cd2198c74e058ac63d28b045c2f1fcec95877bd790e1b\\\",\\\"version\\\":\\\"1\\\"}}"
}
 
application/json

List a specific license

List a specific license using the license id parameter.

get
{protocol}://{hostname}:{port}{path}/licenses/{license-id}

Path Parameters

license-idstringrequired

The license’s unique ID.

Example:30b4edb7-0847-4f65-af90-efbed8b0161f

Response

application/json

The license response object.

created_atinteger

Example:1500508800

idstring

The UUID of the license

Example:30b4edb7-0847-4f65-af90-efbed8b0161f

payloadstring

The Kong Gateway license in JSON format.

Example:{\"license\":{\"payload\":{\"admin_seats\":\"1\",\"customer\":\"Example Company, Inc\",\"dataplanes\":\"1\",\"license_creation_date\":\"2017-07-20\",\"license_expiration_date\":\"2017-07-21\",\"license_key\":\"00141000017ODj3AAG_a1V41000004wT0OEAU\",\"product_subscription\":\"Konnect Enterprise\",\"support_plan\":\"None\"},\"signature\":\"24cc21223633044c15c300be19cacc26ccc5aca0dd9a12df8a7324a1970fe304bc07b8dcd7fb08d7b92e04169313377ae3b550ead653b951bc44cd2eb59f6beb\",\"version\":\"1\"}}

updated_atinteger

Example:1500508800

get/licenses/{license-id}
 
application/json