List roles

Returns a paginated list of all roles

get
http://authorization-admin-api.kauth.svc.cluster.local:8000/v1/roles

Response

200 application/json

Successful response

RolesResponse

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

A role that can be assigned to users or teams

Show Child Parameters
get/roles
 
200 application/json

Create role

Creates a new role

post
http://authorization-admin-api.kauth.svc.cluster.local:8000/v1/roles

Body

application/json

CreateRoleRequest

Request body for creating a role

domainstringrequired

Domain the role is associated with

namestringrequired

Name of the role

display_namestringrequired

Display name of the role

descriptionstringrequired

Description of the role

feature_flagstring | null

Optional feature flag which guards the role

actionsarray[string]required

List of actions granted by the role

entity_typestringrequired

Entity type of the role

internalbooleanrequired

Whether the role is available to Konnect users

Response

application/json

Role created successfully

Role

A role that can be assigned to users or teams

idstringrequired

Unique identifier of the role

domainstringrequired

Domain the role is associated with

namestringrequired

Name of the role

display_namestringrequired

Display name of the role

descriptionstringrequired

Description of the role

feature_flagstring | null

Optional feature flag which guards the role

actionsarray[string]required

List of actions granted by the role

entity_typestringrequired

Entity type of the role

internalbooleanrequired

Whether the role is available to Konnect users

post/roles

Body

{ "domain": "domain", "name": "name", "display_name": "display_name", "description": "description", "actions": [], "entity_type": "entity_type", "internal": false }
 
application/json

Update role

Updates an existing role

patch
http://authorization-admin-api.kauth.svc.cluster.local:8000/v1/roles/{roleId}

Path Parameters

roleIdstringrequired

Unique identifier of the role

Body

application/json

UpdateRoleRequest

Request body for updating a role

display_namestring

Display name of the role

descriptionstring

Description of the role

feature_flagstring | null

Optional feature flag which guards the role

actionsarray[string]

List of actions granted by the role

entity_typestring

Entity type of the role

internalboolean

Whether the role is available to Konnect users

Response

application/json

Role updated successfully

Role

A role that can be assigned to users or teams

idstringrequired

Unique identifier of the role

domainstringrequired

Domain the role is associated with

namestringrequired

Name of the role

display_namestringrequired

Display name of the role

descriptionstringrequired

Description of the role

feature_flagstring | null

Optional feature flag which guards the role

actionsarray[string]required

List of actions granted by the role

entity_typestringrequired

Entity type of the role

internalbooleanrequired

Whether the role is available to Konnect users

patch/roles/{roleId}

Body

{}
 
application/json

Delete role

Deletes a role

delete
http://authorization-admin-api.kauth.svc.cluster.local:8000/v1/roles/{roleId}

Path Parameters

roleIdstringrequired

Unique identifier of the role

Response

Role deleted successfully

delete/roles/{roleId}
 

Teams

Operations for managing teams