Create role assignment for principal

Creates a new role assignment for the specified principal

post
http://authorization-pap-api.kauth.svc.cluster.local:8000/v1/{principalType}/{principalId}/role-assignments

Path Parameters

principalTypestringrequired

Principal types that support role assignments

Allowed values:userssystem-accountsteamsportal-teams

principalIdstring(uuid)required

Contains a unique identifier used for a principal (user, system account, portal developer, etc.)

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Body

application/json

CreateRoleAssignmentRequest

Request body for creating a role assignment

role_assignment_idstring(uuid)

Optional unique identifier for the role assignment

role_krnstringrequired

Kong Resource Name of the role

regionstringrequired

Region where the role applies

resourcestringrequired

Resource identifier

Response

application/json

Role assignment created successfully

RoleAssignment

A role assignment for a subject (user/system account)

idstring(uuid)required

Unique identifier of the role assignment

role_krnstringrequired

Kong Resource Name of the role

role_namestringrequired

Display name of the assigned role

regionstringrequired

Region where the role applies

resourcestringrequired

Resource identifier

entity_type_namestringrequired

Entity type name associated with the role

post/{principalType}/{principalId}/role-assignments

Body

{ "role_krn": "role_krn", "region": "region", "resource": "resource" }
 
application/json

Get role assignment by ID

Returns a specific role assignment for the specified principal

get
http://authorization-pap-api.kauth.svc.cluster.local:8000/v1/{principalType}/{principalId}/role-assignments/{roleAssignmentId}

Path Parameters

principalTypestringrequired

Principal types that support role assignments

Allowed values:userssystem-accountsteamsportal-teams

principalIdstring(uuid)required

Contains a unique identifier used for a principal (user, system account, portal developer, etc.)

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

roleAssignmentIdstringrequired

Unique identifier of the role assignment

Response

application/json

Successful response

RoleAssignment

A role assignment for a subject (user/system account)

idstring(uuid)required

Unique identifier of the role assignment

role_krnstringrequired

Kong Resource Name of the role

role_namestringrequired

Display name of the assigned role

regionstringrequired

Region where the role applies

resourcestringrequired

Resource identifier

entity_type_namestringrequired

Entity type name associated with the role

get/{principalType}/{principalId}/role-assignments/{roleAssignmentId}
 
application/json

Delete role assignment for principal

Deletes a role assignment for the specified principal

delete
http://authorization-pap-api.kauth.svc.cluster.local:8000/v1/{principalType}/{principalId}/role-assignments/{roleAssignmentId}

Path Parameters

principalTypestringrequired

Principal types that support role assignments

Allowed values:userssystem-accountsteamsportal-teams

principalIdstring(uuid)required

Contains a unique identifier used for a principal (user, system account, portal developer, etc.)

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

roleAssignmentIdstringrequired

Unique identifier of the role assignment

Response

Role assignment deleted successfully

delete/{principalType}/{principalId}/role-assignments/{roleAssignmentId}
 

Service Clients

Operations for managing service clients

List service clients

Returns a paginated list of service clients using cursor pagination

get
http://authorization-pap-api.kauth.svc.cluster.local:8000/v1/internal/service-clients

Query Parameters

pageobject

Determines which page of the collection to retrieve.

Show Child Parameters

Response

200 application/json

Successful response

PagedServiceClientResponse

metaobjectrequired
Show Child Parameters
dataarray[object]required

A service client item in a list response

Show Child Parameters
get/internal/service-clients
 
200 application/json