ResourceRulesApi
| Method | HTTP request | Description |
|---|---|---|
| create_authentication_flow_using_post | POST /api/web/v2/authenticationflows | Create an authentication flow |
| create_resource_rule_using_post | POST /api/web/v2/resourcerules | Create a resource rule |
| get_authentication_flow_using_get | GET /api/web/v2/authenticationflows/{id} | Get an authentication flow |
| get_authentication_flows_using_get | GET /api/web/v2/authenticationflows | Get all authentication flows |
| get_resource_rule_using_get | GET /api/web/v2/resourcerules/{id} | Get a resource rule |
| get_resource_rules_for_resource_using_get | GET /api/web/v2/resourcerules/resource/{id} | Get all resource rules for a resource |
| get_resource_rules_using_get | GET /api/web/v2/resourcerules | Get all resource rules |
| get_transaction_rules_using_get | GET /api/web/v1/transactionrules | List all transaction rules |
| remove_authentication_flow_using_delete | DELETE /api/web/v2/authenticationflows/{id} | Delete an authentication flow |
| remove_resource_rule_using_delete | DELETE /api/web/v2/resourcerules/{id} | Delete a resource rule |
| update_authentication_flow_using_put | PUT /api/web/v2/authenticationflows/{id} | Update an authentication flow |
| update_resource_rule_using_put | PUT /api/web/v2/resourcerules/{id} | Update a resource rule |
create_authentication_flow_using_post
AuthenticationFlow create_authentication_flow_using_post(authentication_flow_parms)
Create an authentication flow
Create an authentication flow. Caller requires the CONTEXTRULES:ADD permission.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| authentication_flow_parms | AuthenticationFlowParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
create_resource_rule_using_post
ResourceRule create_resource_rule_using_post(resource_rule_parms)
Create a resource rule
Create a resource rule for a specified resource. Caller requires the CONTEXTRULES:ADD permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| resource_rule_parms | ResourceRuleParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_authentication_flow_using_get
AuthenticationFlow get_authentication_flow_using_get(id)
Get an authentication flow
Get the specified authentication flow. Caller requires the CONTEXTRULES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the authentication flow to be returned. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_authentication_flows_using_get
List[AuthenticationFlow] get_authentication_flows_using_get()
Get all authentication flows
Get all authentication flows. Caller requires the CONTEXTRULES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_resource_rule_using_get
ResourceRule get_resource_rule_using_get(id)
Get a resource rule
Get the specified resource rule. Caller requires the CONTEXTRULES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the resource rule to be returned. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_resource_rules_for_resource_using_get
List[ResourceRule] get_resource_rules_for_resource_using_get(id)
Get all resource rules for a resource
Get all resource rules for the specified resource. Caller requires the CONTEXTRULES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the resource whose resource rules are to be returned. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_resource_rules_using_get
List[ResourceRule] get_resource_rules_using_get()
Get all resource rules
Get all resource rules. Caller requires the CONTEXTRULES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_transaction_rules_using_get
List[TransactionRuleDescription] get_transaction_rules_using_get()
List all transaction rules
Get all transaction rules. Caller requires the CONTEXTRULES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
This endpoint does not need any parameter.
Return type
List[TransactionRuleDescription]
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
remove_authentication_flow_using_delete
DeleteAuthenticationFlowResult remove_authentication_flow_using_delete(id)
Delete an authentication flow
Delete the specified authentication flow. Caller requires the CONTEXTRULES:REMOVE permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the authentication flow to be removed. |
Return type
DeleteAuthenticationFlowResult
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
remove_resource_rule_using_delete
remove_resource_rule_using_delete(id)
Delete a resource rule
Delete the specified resource rule. Caller requires the CONTEXTRULES:REMOVE permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the resource rule to be removed. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
update_authentication_flow_using_put
AuthenticationFlow update_authentication_flow_using_put(id, authentication_flow_parms)
Update an authentication flow
Update the specified authentication flow. Caller requires the CONTEXTRULES:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the authentication flow to be modified. | |
| authentication_flow_parms | AuthenticationFlowParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
update_resource_rule_using_put
update_resource_rule_using_put(id, resource_rule_parms)
Update a resource rule
Update the specified resource rule. Caller requires the CONTEXTRULES:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the resource rule to be modified. | |
| resource_rule_parms | ResourceRuleParms |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |