Skip to Content
kosemdocs
ReferenceAPIAudit log settings

Get audit log settings in project

Gets the audit log settings of an organization or a project. The settings set at this level, of which those unset are absent; what applies, in `effective`, with where each value comes from; and what the level above makes apply, in `inherited`, which a setting unset here takes. The ETag header is the settings' revision.

GET
/v1/projects/{project}/settings/auditLog

Gets the audit log settings of an organization or a project.

The settings set at this level, of which those unset are absent; what applies, in effective, with where each value comes from; and what the level above makes apply, in inherited, which a setting unset here takes. The ETag header is the settings' revision.

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}$

Response Body

OK

application/json
  1. response
dataAccess?array<>

Which calls Data Access records, by service, as set here, besides what the level above records; absent while unset, which adds nothing to it. Reads of audit logs are recorded whatever it says.

dataAccessRetentionDays?integer

How many days Data Access entries are kept, those of the organization's projects included; absent while unset, which keeps them 30 days. Organizations only.

Formatint32
effective*

What the level above makes apply, which this level adds to and cannot turn off: for a project, its organization's effective settings; for an organization, kosem's defaults, which record nothing and keep Data Access entries 30 days.

inherited*

What the level above makes apply, which this level adds to and cannot turn off: for a project, its organization's effective settings; for an organization, kosem's defaults, which record nothing and keep Data Access entries 30 days.

name*string

Resource name, organizations/{organization_id}/settings/auditLog or projects/{project_id}/settings/auditLog.

updateTime?string

When the settings set here last changed; absent if they never did.

Formatdate-time
Example Request
curl -X GET 'https://api.kosem.ai/v1/projects/string/settings/auditLog'
Example Response
{
  "dataAccess": [
    {
      "service": "string",
      "types": [
        "ADMIN_READ"
      ]
    }
  ],
  "dataAccessRetentionDays": 0,
  "effective": {
    "dataAccess": [
      {
        "service": "string",
        "types": [
          {
            "source": "organization",
            "value": "ADMIN_READ"
          }
        ]
      }
    ],
    "dataAccessRetentionDays": {
      "source": "organization",
      "value": 0
    }
  },
  "inherited": {
    "dataAccess": [
      {
        "service": "string",
        "types": [
          {
            "source": "organization",
            "value": "ADMIN_READ"
          }
        ]
      }
    ],
    "dataAccessRetentionDays": {
      "source": "organization",
      "value": 0
    }
  },
  "name": "string",
  "updateTime": "2019-08-24T14:15:22Z"
}