All URIs are relative to https://app.harness.io/gateway/pm/
| Method | HTTP request | Description |
|---|---|---|
| EvaluateEvaluate | Post /api/v1/evaluate | |
| EvaluateEvaluateByIds | Post /api/v1/evaluate-by-ids | |
| EvaluateEvaluateByType | Post /api/v1/evaluate-by-type | |
| EvaluateEvaluateByTypeCheck | Get /api/v1/evaluate-by-type-check | evaluate-by-type-check evaluate |
EvaluatedPolicy EvaluateEvaluate(ctx, body, optional)
Evaluate arbitrary rego
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | EvaluateRequestBody | ||
| optional | *EvaluateApiEvaluateEvaluateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a EvaluateApiEvaluateEvaluateOpts struct
| Name | Type | Description | Notes |
|---|
accountIdentifier | optional.| Harness account ID | orgIdentifier | optional.| Harness organization ID | projectIdentifier | optional.| Harness project ID | xApiKey | optional.| Harness PAT key used to perform authorization |
api_key_header_x-api-key, jwt_header_Authorization
- Content-Type: application/json
- Accept: application/json, application/vnd.goa.error
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Evaluation EvaluateEvaluateByIds(ctx, ids, optional)
Evaluate policy sets by ID
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| ids | string | Comma-separated list of identifiers for the policy sets that should be evaluated, with account. or org. prefixes if needed | |
| optional | *EvaluateApiEvaluateEvaluateByIdsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a EvaluateApiEvaluateEvaluateByIdsOpts struct
| Name | Type | Description | Notes |
|---|
accountIdentifier | optional.String| Harness account ID | orgIdentifier | optional.String| Harness organization ID | projectIdentifier | optional.String| Harness project ID | entity | optional.String| User-supplied global identifier of the entity under evaluation | entityMetadata | optional.String| User-supplied additional metadata for the entity under evaluation | principalIdentifier | optional.String| Identifier of the principal that triggered the evaluation - must be specified in conjunction with 'principalType' | principalType | optional.String| Type of principal that triggered the evaluation - must be specified in conjunction with 'principalIdentifier' | userIdentifier | optional.String| Deprecated: Please use 'principalIdentifier' and 'principalType' instead | xApiKey | optional.String| Harness PAT key used to perform authorization |
api_key_header_x-api-key, jwt_header_Authorization
- Content-Type: Not defined
- Accept: application/json, application/vnd.goa.error
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Evaluation EvaluateEvaluateByType(ctx, type_, action, optional)
Evaluate all policy sets of a specified type
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| type_ | string | Type of entity under evaluation | |
| action | string | Action that triggered the evaluation | |
| optional | *EvaluateApiEvaluateEvaluateByTypeOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a EvaluateApiEvaluateEvaluateByTypeOpts struct
| Name | Type | Description | Notes |
|---|
accountIdentifier | optional.String| Harness account ID | orgIdentifier | optional.String| Harness organization ID | projectIdentifier | optional.String| Harness project ID | entity | optional.String| User-supplied global identifier of the entity under evaluation | entityMetadata | optional.String| User-supplied additional metadata for the entity under evaluation | principalIdentifier | optional.String| Identifier of the principal that triggered the evaluation - must be specified in conjunction with 'principalType' | principalType | optional.String| Type of principal that triggered the evaluation - must be specified in conjunction with 'principalIdentifier' | userIdentifier | optional.String| Deprecated: Please use 'principalIdentifier' and 'principalType' instead | xApiKey | optional.String| Harness PAT key used to perform authorization |
api_key_header_x-api-key, jwt_header_Authorization
- Content-Type: Not defined
- Accept: application/json, application/vnd.goa.error
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EvaluateByTypeCheckResponseBody EvaluateEvaluateByTypeCheck(ctx, type_, action, optional) evaluate-by-type-check evaluate
Returns true if there are policies to evaluate for the given type, action and acc/org/proj scope.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| type_ | string | Type of entity under evaluation | |
| action | string | Action that triggered the evaluation | |
| optional | *EvaluateApiEvaluateEvaluateByTypeCheckOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a EvaluateApiEvaluateEvaluateByTypeCheckOpts struct
| Name | Type | Description | Notes |
|---|
accountIdentifier | optional.String| Harness account ID | orgIdentifier | optional.String| Harness organization ID | projectIdentifier | optional.String| Harness project ID | entity | optional.String| User-supplied global identifier of the entity under evaluation | xApiKey | optional.String| Harness PAT key used to perform authorization |
EvaluateByTypeCheckResponseBody
api_key_header_x-api-key, jwt_header_Authorization
- Content-Type: Not defined
- Accept: application/json, application/vnd.goa.error
[Back to top] [Back to API list] [Back to Model list] [Back to README]