Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

List of organization activities

GET/v1/organizations/{organizationId}/activities
API playground

Returns a list of all organization activities.

Permission

The API key must have the control-plane:organization:view-activities permission.

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the requested organization.

    format: uuid

Query parameters

  • from_dateoptionalstring

    A starting date for a search

    format: date-time
  • to_dateoptionalstring

    An ending date for a search

    format: date-time

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalarray ofobject
    16 properties
    • idoptionalstring

      Unique activity ID.

    • createdAtoptionalstring

      Timestamp of the activity. ISO-8601.

      format: date-time
    • typeoptionalcreate_organizationordelete_organizationororganization_update_nameortransfer_service_inortransfer_service_outorsave_payment_method+112 more

      Type of the activity.

    • actorTypeoptionaluserorsupportorsystemorapi

      Type of the actor: 'user', 'support', 'system', 'api'.

    • actorIdoptionalstring

      Unique actor ID.

    • actorDetailsoptionalstring

      Additional information about the actor.

    • actorIpAddressoptionalstring

      IP address of the actor. Defined for 'user' and 'api' actor types.

    • organizationIdoptionalstring

      Scope of the activity: organization ID this activity is related to.

    • serviceIdoptionalstring

      Scope of the activity: service ID this activity is related to.

    • userAgentoptionalstring

      User agent of the actor

    • targetKeyIdoptionalstring

      For 'openapi_key_update' activities: the ID of the API key that was updated.

    • keyUpdateTypeoptionalcreatedordeletedorname-changedorrole-changedorstate-changedordate-changed+5 more

      For 'openapi_key_update' activities: the type of update that was performed.

    • targetRoleIdsoptionalarray ofstring

      For role and actor-role activities: IDs of the affected roles.

    • targetRoleNamesoptionalarray ofstring

      For role and actor-role activities: names of the affected roles, when recorded.

    • targetActorIdsoptionalarray ofstring

      For 'organization_member_update_roles' and 'organization_member_remove_roles' activities: IDs of the affected actors (e.g. 'user/').

    • targetResourceIdsoptionalarray ofstring

      For 'role_resources_delete' activities: IDs of the deleted resources the roles referenced.

Report an issue
Navigation