Skip to Content
kosemdocs
ReferenceAPIAgents

List access profile agent grants

Lists the agents holding a project access profile, with granted scope, expiry, and usage counts. Private agents' titles are omitted.

GET
/v1/projects/{project}/accessProfiles/{accessProfile}/agentGrants

Lists the agents holding a project access profile, with granted scope, expiry, and usage counts. Private agents' titles are omitted.

Authorization

bearer
headerAuthorizationBearer <token>

An access token, or an API key.

Path Parameters

project*string

The project's ID.

Match^prj_[0-7][0-9a-hjkmnp-tv-z]{25}$
accessProfile*string

The access profile's ID.

Match^acp_[0-7][0-9a-hjkmnp-tv-z]{25}$

Query Parameters

pageSize?integer

Maximum number of items to return. Defaults to 50; values above 500 are treated as 500.

Formatint32
Range0 <= value
pageToken?string

Page token from a previous response.

Response Body

OK

application/json
  1. response
grants*array<>

Agents holding this resource, newest grant first.

nextPageToken*string

Token for the next page; empty on the last page.

Example Request
curl -X GET 'https://api.kosem.ai/v1/projects/string/accessProfiles/string/agentGrants'
Example Response
{
  "grants": [
    {
      "agent": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "expireTime": "2019-08-24T14:15:22Z",
      "grantId": "string",
      "grantor": "string",
      "lastUsedTime": "2019-08-24T14:15:22Z",
      "private": true,
      "scope": {
        "property1": null,
        "property2": null
      },
      "title": "string",
      "useCount": 0
    }
  ],
  "nextPageToken": "string"
}