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

Get service client

Returns details of a specific service client

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

Path Parameters

idstring(uuid)required

Unique identifier of the service client

Response

application/json

Successful response

ServiceClient

A service client with full details including actions

idstring(uuid)required

Unique identifier of the service client

namestringrequired

Name of the service client

descriptionstringrequired

Description of the service client

created_atstring(date-time)required

Timestamp when the service client was created

updated_atstring(date-time)required

Timestamp when the service client was last updated

actionsarray[object]required

A reference to an action resource containing only the ID, used for service clients.

Show Child Parameters
get/internal/service-clients/{id}
 
application/json

Update service client

Updates an existing service client

put
http://authorization-pap-api.kauth.svc.cluster.local:8000/v1/internal/service-clients/{id}

Path Parameters

idstring(uuid)required

Unique identifier of the service client

Body

application/json

UpdateServiceClientRequest

Request body for updating a service client

namestringrequired

Name of the service client

descriptionstringrequired

Description of the service client

actionsarray[object]required

A reference to an action resource containing only the ID, used for service clients.

Show Child Parameters

Response

application/json

Service client updated successfully

ServiceClient

A service client with full details including actions

idstring(uuid)required

Unique identifier of the service client

namestringrequired

Name of the service client

descriptionstringrequired

Description of the service client

created_atstring(date-time)required

Timestamp when the service client was created

updated_atstring(date-time)required

Timestamp when the service client was last updated

actionsarray[object]required

A reference to an action resource containing only the ID, used for service clients.

Show Child Parameters
put/internal/service-clients/{id}

Body

{ "name": "name", "description": "description", "actions": [ { "id": "id" } ] }
 
application/json

Delete service client

Deletes a service client

delete
http://authorization-pap-api.kauth.svc.cluster.local:8000/v1/internal/service-clients/{id}

Path Parameters

idstring(uuid)required

Unique identifier of the service client

Response

Service client deleted successfully

delete/internal/service-clients/{id}