Activity

List Activity Reports

get
Authorizations
Query parameters
limitinteger · int32OptionalDefault: 100
namestring | nullableOptional

The name of the report. Supports wildcard () for partial matches - use * for contains, prefix for starts with, *suffix for ends with

page_tokenstring | nullableOptional
Responses
200

OK

application/json
get
/api/admin/v1/activity-reports
GET /api/admin/v1/activity-reports HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "fields": [
        "text"
      ],
      "filters": {
        "requestor_source_ids": [
          "text"
        ],
        "grantee_source_ids": [
          "text"
        ],
        "grantee_identity_types": [
          "text"
        ],
        "integration_ids": [
          "text"
        ],
        "permission_names": [
          "text"
        ],
        "resource_ids": [
          "text"
        ],
        "resource_types": [
          "text"
        ],
        "statuses": [
          "text"
        ],
        "trigger_types": [
          "text"
        ],
        "access_flow_ids": [
          "text"
        ]
      },
      "timeframe": {
        "absolute": {
          "start_date": "2022-03-10T16:15:50Z",
          "end_date": "2022-03-10T16:15:50Z"
        },
        "relative": {
          "last": 1,
          "unit": "text",
          "rounded": true
        }
      },
      "schedule": {
        "cron_expression": "text",
        "recipients": [
          "text"
        ]
      },
      "format": "text",
      "creation_date": "2022-03-10T16:15:50Z",
      "update_date": "2022-03-10T16:15:50Z"
    }
  ],
  "pagination": {
    "next_page_token": "text"
  }
}

Create Activity Report

post
Authorizations
Body
namestringRequired

Display name of the report. Must be unique.

fieldsstring[] | nullableOptional

List of fields to include in the report. Possible values: request_id, request_date, request_grant_date, request_revoke_date, requestor_name, requestor_email, grantee_name, grantee_id, grantee_type, integration, resources, resource_type, permissions, approver_names, approver_emails, approver_types, justification, status, approver_reason, resources_status, trigger_type, access_flow, bundle_name.

scheduleall of | nullableOptional
formatstring | nullableOptional

Format of the report. Possible values: csv, pdf. Default is csv

Responses
200

OK

application/json
post
/api/admin/v1/activity-reports
POST /api/admin/v1/activity-reports HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 542

{
  "name": "text",
  "fields": [
    "text"
  ],
  "filters": {
    "requestor_source_ids": [
      "text"
    ],
    "grantee_source_ids": [
      "text"
    ],
    "grantee_identity_types": [
      "text"
    ],
    "integration_ids": [
      "text"
    ],
    "permission_names": [
      "text"
    ],
    "resource_ids": [
      "text"
    ],
    "resource_types": [
      "text"
    ],
    "statuses": [
      "text"
    ],
    "trigger_types": [
      "text"
    ],
    "access_flow_ids": [
      "text"
    ]
  },
  "timeframe": {
    "absolute": {
      "start_date": "2022-03-10T16:15:50Z",
      "end_date": "2022-03-10T16:15:50Z"
    },
    "relative": {
      "last": 1,
      "unit": "text",
      "rounded": true
    }
  },
  "schedule": {
    "cron_expression": "text",
    "recipients": [
      "text"
    ]
  },
  "format": "text"
}
200

OK

{
  "id": "text",
  "name": "text",
  "fields": [
    "text"
  ],
  "filters": {
    "requestor_source_ids": [
      "text"
    ],
    "grantee_source_ids": [
      "text"
    ],
    "grantee_identity_types": [
      "text"
    ],
    "integration_ids": [
      "text"
    ],
    "permission_names": [
      "text"
    ],
    "resource_ids": [
      "text"
    ],
    "resource_types": [
      "text"
    ],
    "statuses": [
      "text"
    ],
    "trigger_types": [
      "text"
    ],
    "access_flow_ids": [
      "text"
    ]
  },
  "timeframe": {
    "absolute": {
      "start_date": "2022-03-10T16:15:50Z",
      "end_date": "2022-03-10T16:15:50Z"
    },
    "relative": {
      "last": 1,
      "unit": "text",
      "rounded": true
    }
  },
  "schedule": {
    "cron_expression": "text",
    "recipients": [
      "text"
    ]
  },
  "format": "text",
  "creation_date": "2022-03-10T16:15:50Z",
  "update_date": "2022-03-10T16:15:50Z"
}

Get Activity Report

get
Authorizations
Path parameters
idstringRequired
Responses
200

OK

application/json
get
/api/admin/v1/activity-reports/{id}
GET /api/admin/v1/activity-reports/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "id": "text",
  "name": "text",
  "fields": [
    "text"
  ],
  "filters": {
    "requestor_source_ids": [
      "text"
    ],
    "grantee_source_ids": [
      "text"
    ],
    "grantee_identity_types": [
      "text"
    ],
    "integration_ids": [
      "text"
    ],
    "permission_names": [
      "text"
    ],
    "resource_ids": [
      "text"
    ],
    "resource_types": [
      "text"
    ],
    "statuses": [
      "text"
    ],
    "trigger_types": [
      "text"
    ],
    "access_flow_ids": [
      "text"
    ]
  },
  "timeframe": {
    "absolute": {
      "start_date": "2022-03-10T16:15:50Z",
      "end_date": "2022-03-10T16:15:50Z"
    },
    "relative": {
      "last": 1,
      "unit": "text",
      "rounded": true
    }
  },
  "schedule": {
    "cron_expression": "text",
    "recipients": [
      "text"
    ]
  },
  "format": "text",
  "creation_date": "2022-03-10T16:15:50Z",
  "update_date": "2022-03-10T16:15:50Z"
}

Update Access Flow

put
Authorizations
Path parameters
idstringRequired
Body
namestringRequired

Display name of the report. Must be unique.

fieldsstring[] | nullableOptional

List of fields to include in the report. Possible values: request_id, request_date, request_grant_date, request_revoke_date, requestor_name, requestor_email, grantee_name, grantee_id, grantee_type, integration, resources, resource_type, permissions, approver_names, approver_emails, approver_types, justification, status, approver_reason, resources_status, trigger_type, access_flow, bundle_name.

scheduleall of | nullableOptional
formatstring | nullableOptional

Format of the report. Possible values: csv, pdf. Default is csv

Responses
200

OK

application/json
put
/api/admin/v1/activity-reports/{id}
PUT /api/admin/v1/activity-reports/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 542

{
  "name": "text",
  "fields": [
    "text"
  ],
  "filters": {
    "requestor_source_ids": [
      "text"
    ],
    "grantee_source_ids": [
      "text"
    ],
    "grantee_identity_types": [
      "text"
    ],
    "integration_ids": [
      "text"
    ],
    "permission_names": [
      "text"
    ],
    "resource_ids": [
      "text"
    ],
    "resource_types": [
      "text"
    ],
    "statuses": [
      "text"
    ],
    "trigger_types": [
      "text"
    ],
    "access_flow_ids": [
      "text"
    ]
  },
  "timeframe": {
    "absolute": {
      "start_date": "2022-03-10T16:15:50Z",
      "end_date": "2022-03-10T16:15:50Z"
    },
    "relative": {
      "last": 1,
      "unit": "text",
      "rounded": true
    }
  },
  "schedule": {
    "cron_expression": "text",
    "recipients": [
      "text"
    ]
  },
  "format": "text"
}
200

OK

{
  "id": "text",
  "name": "text",
  "fields": [
    "text"
  ],
  "filters": {
    "requestor_source_ids": [
      "text"
    ],
    "grantee_source_ids": [
      "text"
    ],
    "grantee_identity_types": [
      "text"
    ],
    "integration_ids": [
      "text"
    ],
    "permission_names": [
      "text"
    ],
    "resource_ids": [
      "text"
    ],
    "resource_types": [
      "text"
    ],
    "statuses": [
      "text"
    ],
    "trigger_types": [
      "text"
    ],
    "access_flow_ids": [
      "text"
    ]
  },
  "timeframe": {
    "absolute": {
      "start_date": "2022-03-10T16:15:50Z",
      "end_date": "2022-03-10T16:15:50Z"
    },
    "relative": {
      "last": 1,
      "unit": "text",
      "rounded": true
    }
  },
  "schedule": {
    "cron_expression": "text",
    "recipients": [
      "text"
    ]
  },
  "format": "text",
  "creation_date": "2022-03-10T16:15:50Z",
  "update_date": "2022-03-10T16:15:50Z"
}

Delete Activity Report

delete
Authorizations
Path parameters
idstringRequired
Responses
200

OK

application/json
delete
/api/admin/v1/activity-reports/{id}
DELETE /api/admin/v1/activity-reports/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "message": "text"
}

List Activity

get
Authorizations
Query parameters
end_dateinteger · int64 | nullableOptional
filter[access_flow_id]string[] | nullableOptional
filter[access_request_id]string[] | nullableOptional
filter[integration_id]string[] | nullableOptional
filter[permission]string[] | nullableOptional
filter[requestor_id]string[] | nullableOptional
filter[resource]string[] | nullableOptional
filter[resource_type]string[] | nullableOptional
filter[status]string[] | nullableOptional
filter[trigger_type]string[] | nullableOptional
start_dateinteger · int64 | nullableOptional
Responses
200

OK

application/json
get
/api/v3/activity
GET /api/v3/activity HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "data": [
    {
      "request_id": "text",
      "request_date": "text",
      "requestor_name": "text",
      "requestor_email": "text",
      "integration": "text",
      "resource_type": "text",
      "resources": [
        "text"
      ],
      "permissions": [
        "text"
      ],
      "justification": "text",
      "status": "text",
      "trigger_type": "text",
      "access_flow": "text"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}
PreviousNew EndpointsNextAttributes

Last updated

Was this helpful?