Access Reports

The Access Reports API is a convenient way of generating reports on Users and Resources for your Team. You can use Okta Workflows to interact with these operations and store generated reports in a Workflows Table.

List all Access Reports

Lists all Access Reports

This endpoint requires the following role: security_admin.

SecuritybearerAuth
Request
path Parameters
team_name
required
string

The name of your Team

Responses
200

OK

get/v1/teams/{team_name}/access_reports
Request samples 
Response samples 
application/json
{
  • "list": [
    • {
      }
    ]
}
Create an Access Report
Create an Access Report. Each report must be connected to a specific User or Resource.


This endpoint requires the following role: security_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
Request Body schema: application/json
One of:
object
 
id
string <regex>  (AccessReportTargetID) (?i)^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}...
The UUID of an existing OPA User or Resource


 
resource_type_filter
string (AccessReportTargetResourceType) 
The type of resource associated with the Access Report


 Value: "server"  
Responses 
201
Created


post/v1/teams/{team_name}/access_reports
Request samples 
application/json
{
  • "user": {
    • "id": "5fdf5ae9-e4db-4aae-8127-c2ebffe747f6",
    • "resource_type_filter": "server"
    }
}
Response samples 
application/json
{
  • "created_at": "2023-08-25T12:00:00.000000Z",
  • "details": {
    • "user": {
      }
    },
  • "id": "5fdf5ae9-e71b-423e-8a87-c2ebffe407f6",
  • "status": "COMPLETED",
  • "updated_at": "2023-08-25T12:00:00.000000Z"
}
Retrieve an Access Report
Retrieve the metadata of the specified Access Report


This endpoint requires the following role: security_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
access_report_id
required
string
The UUID of an Access Report


 
Responses 
200
OK


get/v1/teams/{team_name}/access_reports/{access_report_id}
Request samples 
Response samples 
application/json
{
  • "created_at": "2023-08-25T12:00:00.000000Z",
  • "details": {
    • "user": {
      }
    },
  • "id": "5fdf5ae9-e71b-423e-8a87-c2ebffe407f6",
  • "status": "COMPLETED",
  • "updated_at": "2023-08-25T12:00:00.000000Z"
}
Download an Access Report
Downloads the specific Access Report for review. The CSV formatted report is included in the response.


This endpoint requires the following role: security_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
access_report_id
required
string
The UUID of an Access Report


 
Responses 
200
OK


get/v1/teams/{team_name}/access_reports/{access_report_id}/report
Request samples