Harness

Analyze Organization Access Policy

Analyze access policies within a organization

Analyze access policies within a organization

Securityx-api-key
Request
path Parameters
org
required
string

Organization identifier

query Parameters
page
integer
Default: 0

Pagination page number strategy: Specify the page number within the paginated collection related to the number of items on each page.

limit
integer <= 100
Default: 30

Pagination: Number of items to return.

sort
string

Parameter on the basis of which sorting is done.

Enum: "identifier" "name" "created" "updated"
order
string

Order on the basis of which sorting is done.

Enum: "ASC" "DESC"
header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

Request Body schema: application/json

This is the request body that accepts parameters based on which access policies will be analysed

object (QueryScopeRequest)

This includes details about the scope for which policies should be analysed

object (Principal)

Role assignment principal

permission_identifier
string

Permission identifier for which access policies need to be analysed.

resource_group_identifier
string

Resource group identifiert for which access policies need to be analysed.

object (RoleRequest)

Request to analyze policies based on Role details

object (Resource)

Request to analyze access policies based on Resource details. Resource scope can be provided from query scope or its child scope

object (AccessAnalysisAdvanceOptions)

Advance Options to control the output of a given query

Responses
200

Example response

post/v1/orgs/{org}/analyze-access-policies
Request samples
application/json
{
  • "query_scope": {
    },
  • "principal": {
    },
  • "permission_identifier": "string",
  • "resource_group_identifier": "string",
  • "role": {
    },
  • "resource": {
    },
  • "advance_options": {
    }
}
Response samples
application/json
{
  • "access_policy_analysis_response": [
    ]
}
➔ Next to Analyze Project Access Policy