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

Request body schema for assigning or updating roles for a group.

rbac_role_idstringrequired

The ID of the RBAC role to assign.

Example:12773c9a-7f7c-45f2-bcea-5285eb18fd2f

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": "12773c9a-7f7c-45f2-bcea-5285eb18fd2f"
}
 
201 application/json

List all Workspaces

List all Workspaces

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

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

offsetstring

Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources

tagsstring

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.

Example:tag1,tag2

Response

application/json

A successful response listing Workspaces

dataarray[object]

Workspaces provide a way to segment Kong entities.

Show Child Parameters
nextstring

URI to the next page (may be null)

offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

get/workspaces
 
application/json

Create a new Workspace

Create a new Workspace

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

Body

application/json

Description of the new Workspace for creation

Workspace

Workspaces provide a way to segment Kong entities.

commentstring
configobject
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

idstring

The unique UUID for this resource.

metaobject
Show Child Parameters
namestring

Response

application/json

Successfully created Workspace

Workspace

Workspaces provide a way to segment Kong entities.

commentstring
configobject
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

idstring

The unique UUID for this resource.

metaobject
Show Child Parameters
namestring
post/workspaces

Body

{
"comment": "comment",
"config": {
"meta": {},
"portal": false,
"portal_access_request_email": false,
"portal_application_request_email": false,
"portal_application_status_email": false,
"portal_approved_email": false,
"portal_auth": "portal_auth",
"portal_auth_conf": "portal_auth_conf",
"portal_auto_approve": false,
"portal_cors_origins": [
"[]"
],
"portal_developer_meta_fields": "[{\"label\":\"Full Name\",\"title\":\"full_name\",\"validator\":{\"required\":true,\"type\":\"string\"}}]",
"portal_emails_from": "portal_emails_from",
"portal_emails_reply_to": "portal_emails_reply_to",
"portal_invite_email": false,
"portal_is_legacy": false,
"portal_reset_email": false,
"portal_reset_success_email": false,
"portal_session_conf": "portal_session_conf",
"portal_smtp_admin_emails": [
"[]"
],
"portal_token_exp": 0
},
"created_at": 0,
"id": "id",
"meta": {
"color": "color",
"thumbnail": "thumbnail"
},
"name": "name"
}
 
application/json

Delete a Workspace

Delete a Workspace

delete
{protocol}://{hostname}:{port}{path}/workspaces/{WorkspaceIdOrName}

Path Parameters

WorkspaceIdOrNamestringrequired

ID or name of the Workspace to lookup

Example:[ "" ]

Response

Successfully deleted Workspace or the resource didn’t exist

delete/workspaces/{WorkspaceIdOrName}
 

Did this doc help?

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!