Authorization Config API (0.0.1)

Download OpenAPI specification:Download

Authorization Config API documentation

Authorization Config API

List all Policies

Lists all defined Policies.

Authorizations:

bearer

path Parameters

tenant

required

string

Your tenant code.

query Parameters

q	string Optional search query param for filtering policies based on content.

header Parameters

acting-tenant-id	string Tenant code. Used when not passing the tenant code in the URL path parameter
tenant-id	string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

List all Policies

Lists all defined Policies.

Authorizations:

bearer

path Parameters

tenant

required

string

Your tenant code.

query Parameters

q	string Optional search query param for filtering policies based on content.

header Parameters

acting-tenant-id	string Tenant code. Used when not passing the tenant code in the URL path parameter
tenant-id	string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Get a Policy

Returns a specific Policy.

Authorizations:

bearer

path Parameters

policyName required	string The identifier for the Policy.
tenant required	string Your tenant code.

header Parameters

acting-tenant-id	string Tenant code. Used when not passing the tenant code in the URL path parameter
tenant-id	string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

200

Content type

application/json

{"name": "string",
"rego": "string",
"graph": { }
}

Create/update Policy

Creates or updates a Policy.

Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.

Authorizations:

bearer

path Parameters

policyName required	string The identifier for the Policy.
tenant required	string Your tenant code.

header Parameters

acting-tenant-id	string Tenant code. Used when not passing the tenant code in the URL path parameter
tenant-id	string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json

rego	string The raw Rego policy data. Either rego or graph must be provided. If both are provided then graph takes precedence over rego.
	object The graphical representation of the Rego policy. The graphical representation will be converted to a Rego policy. Either rego or graph must be provided. If both are provided then graph takes precedence over rego.
isReadOnly	boolean

Responses

Request samples

Payload

Content type

application/json

{"rego": "string",
"graph": {"nodes": [{"id": "string",
"name": "string",
"description": "string",
"type": { },
"roles": [{ }
]
}
],
"links": [{"id": "string",
"name": "string",
"description": "string",
"sourceId": "string",
"targetId": "string",
"roles": ["string"
]
}
]
},
"isReadOnly": true
}

Delete a Policy

Removes the Policy specified by {policyName}.

Authorizations:

bearer

path Parameters

policyName required	string The identifier for the Policy.
tenant required	string Your tenant code.

header Parameters

acting-tenant-id	string Tenant code. Used when not passing the tenant code in the URL path parameter
tenant-id	string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Get a Policy

Returns a specific Policy.

Authorizations:

bearer

path Parameters

policyName required	string The identifier for the Policy.
tenant required	string Your tenant code.

header Parameters

acting-tenant-id	string Tenant code. Used when not passing the tenant code in the URL path parameter
tenant-id	string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

200

Content type

application/json

{"name": "string",
"rego": "string",
"graph": { }
}

Create/update Policy

Creates or updates a Policy.

Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.

Authorizations:

bearer

path Parameters

policyName required	string The identifier for the Policy.
tenant required	string Your tenant code.

header Parameters

acting-tenant-id	string Tenant code. Used when not passing the tenant code in the URL path parameter
tenant-id	string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json

rego	string The raw Rego policy data. Either rego or graph must be provided. If both are provided then graph takes precedence over rego.
	object The graphical representation of the Rego policy. The graphical representation will be converted to a Rego policy. Either rego or graph must be provided. If both are provided then graph takes precedence over rego.
isReadOnly	boolean

Responses

Request samples

Payload

Content type

application/json

{"rego": "string",
"graph": {"nodes": [{"id": "string",
"name": "string",
"description": "string",
"type": { },
"roles": [{ }
]
}
],
"links": [{"id": "string",
"name": "string",
"description": "string",
"sourceId": "string",
"targetId": "string",
"roles": ["string"
]
}
]
},
"isReadOnly": true
}

Delete a Policy

Removes the Policy specified by {policyName}.

Authorizations:

bearer

path Parameters

policyName required	string The identifier for the Policy.
tenant required	string Your tenant code.

header Parameters

acting-tenant-id	string Tenant code. Used when not passing the tenant code in the URL path parameter
tenant-id	string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant