UpdateActionRequest

object

Request body for updating an action

descriptionstring

Description of the action

resourcestring

Resource the action is associated with

globalboolean

Flag to indicate if the action is global

actionstring

Legacy format of the action

Example

Role

object

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

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

Example

CreateRoleRequest

object

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

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

Example

UpdateRoleRequest

object

Request body for updating a role

display_namestring

Display name of the role

descriptionstring

Description of the role

feature_flagstring

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

Example

Team

object

A team that can be assigned roles

idstringrequired

Unique identifier of the team

domainstringrequired

Domain the team is associated with

namestringrequired

Name of the team

display_namestringrequired

Display name of the team

descriptionstringrequired

Description of the team

feature_flagstringrequired

Optional feature flag which guards the team

rolesarray[string]required

List of roles assigned to the team

Example