Create team

Creates a new team

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

Body

application/json

CreateTeamRequest

Request body for creating a 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_flagstring | null

Optional feature flag which guards the team

rolesarray[string]required

List of roles assigned to the team

Response

application/json

Team created successfully

Team

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_flagstring | nullrequired

Optional feature flag which guards the team

rolesarray[string]required

List of roles assigned to the team

post/teams

Body

{ "domain": "domain", "name": "name", "display_name": "display_name", "description": "description", "roles": [] }
 
application/json

Update team

Updates an existing team

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

Path Parameters

teamIdstringrequired

Unique identifier of the team

Body

application/json

UpdateTeamRequest

Request body for updating a team

display_namestring

Display name of the team

descriptionstring

Description of the team

feature_flagstring | null

Optional feature flag which guards the team

rolesarray[string]

List of roles assigned to the team

Response

application/json

Team updated successfully

Team

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_flagstring | nullrequired

Optional feature flag which guards the team

rolesarray[string]required

List of roles assigned to the team

patch/teams/{teamId}

Body

{}
 
application/json

Delete team

Deletes a team

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

Path Parameters

teamIdstringrequired

Unique identifier of the team

Response

Team deleted successfully

delete/teams/{teamId}
 

Permission Sync

Operations for permission synchronization

Start permission synchronization

Initiates permission synchronization process

post
http://authorization-admin-api.kauth.svc.cluster.local:8000/v1/perm-sync/start

Body

application/json

StartPermSyncRequest

Request body for starting permission synchronization

targetingobject

Targeting configuration dictating which organizations to sync

Show Child Parameters
rolesarray[string]

List of role identifiers to sync in format domain#name

Match pattern:^[^#]+#[^#]+$

Example:["accounts#AppAuthStrategyCreator","accounts#PortalAdmin"]

teamsarray[string]

List of team identifiers to sync in format domain#name

Match pattern:^[^#]+#[^#]+$

Example:["accounts#AnalyticsAdmin","accounts#AnalyticsViewer"]

Response

Permission sync started successfully (no content)

post/perm-sync/start

Body

{}