ResourceRulesApi
| Method | HTTP request | Description |
|---|---|---|
| createAuthenticationFlowUsingPOST | POST /api/web/v2/authenticationflows | Create an authentication flow |
| createResourceRuleUsingPOST | POST /api/web/v2/resourcerules | Create a resource rule |
| getAuthenticationFlowUsingGET | GET /api/web/v2/authenticationflows/{id} | Get an authentication flow |
| getAuthenticationFlowsUsingGET | GET /api/web/v2/authenticationflows | Get all authentication flows |
| getResourceRuleUsingGET | GET /api/web/v2/resourcerules/{id} | Get a resource rule |
| getResourceRulesForResourceUsingGET | GET /api/web/v2/resourcerules/resource/{id} | Get all resource rules for a resource |
| getResourceRulesUsingGET | GET /api/web/v2/resourcerules | Get all resource rules |
| getTransactionRulesUsingGET | GET /api/web/v1/transactionrules | List all transaction rules |
| removeAuthenticationFlowUsingDELETE | DELETE /api/web/v2/authenticationflows/{id} | Delete an authentication flow |
| removeResourceRuleUsingDELETE | DELETE /api/web/v2/resourcerules/{id} | Delete a resource rule |
| updateAuthenticationFlowUsingPUT | PUT /api/web/v2/authenticationflows/{id} | Update an authentication flow |
| updateResourceRuleUsingPUT | PUT /api/web/v2/resourcerules/{id} | Update a resource rule |
createAuthenticationFlowUsingPOST
AuthenticationFlow createAuthenticationFlowUsingPOST(authenticationFlowParms)
Create an authentication flow
Create an authentication flow. Caller requires the CONTEXTRULES:ADD permission.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| authenticationFlowParms | 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 | - |
createResourceRuleUsingPOST
ResourceRule createResourceRuleUsingPOST(resourceRuleParms)
Create a resource rule
Create a resource rule for a specified resource. Caller requires the CONTEXTRULES:ADD permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| resourceRuleParms | 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 | - |
getAuthenticationFlowUsingGET
AuthenticationFlow getAuthenticationFlowUsingGET(id)
Get an authentication flow
Get the specified authentication flow. Caller requires the CONTEXTRULES:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | 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 | - |
getAuthenticationFlowsUsingGET
List<AuthenticationFlow> getAuthenticationFlowsUsingGET()
Get all authentication flows
Get all authentication flows. Caller requires the CONTEXTRULES:VIEW permission.
Example
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 | - |
getResourceRuleUsingGET
ResourceRule getResourceRuleUsingGET(id)
Get a resource rule
Get the specified resource rule. Caller requires the CONTEXTRULES:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | 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 | - |
getResourceRulesForResourceUsingGET
List<ResourceRule> getResourceRulesForResourceUsingGET(id)
Get all resource rules for a resource
Get all resource rules for the specified resource. Caller requires the CONTEXTRULES:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | 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 | - |
getResourceRulesUsingGET
List<ResourceRule> getResourceRulesUsingGET()
Get all resource rules
Get all resource rules. Caller requires the CONTEXTRULES:VIEW permission.
Example
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 | - |
getTransactionRulesUsingGET
List<TransactionRuleDescription> getTransactionRulesUsingGET()
List all transaction rules
Get all transaction rules. Caller requires the CONTEXTRULES:VIEW permission.
Example
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 | - |
removeAuthenticationFlowUsingDELETE
DeleteAuthenticationFlowResult removeAuthenticationFlowUsingDELETE(id)
Delete an authentication flow
Delete the specified authentication flow. Caller requires the CONTEXTRULES:REMOVE permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | 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 | - |
removeResourceRuleUsingDELETE
removeResourceRuleUsingDELETE(id)
Delete a resource rule
Delete the specified resource rule. Caller requires the CONTEXTRULES:REMOVE permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the resource rule to be removed. |
Return type
null (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 | - |
updateAuthenticationFlowUsingPUT
AuthenticationFlow updateAuthenticationFlowUsingPUT(id, authenticationFlowParms)
Update an authentication flow
Update the specified authentication flow. Caller requires the CONTEXTRULES:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the authentication flow to be modified. | |
| authenticationFlowParms | 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 | - |
updateResourceRuleUsingPUT
updateResourceRuleUsingPUT(id, resourceRuleParms)
Update a resource rule
Update the specified resource rule. Caller requires the CONTEXTRULES:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the resource rule to be modified. | |
| resourceRuleParms | ResourceRuleParms |
Return type
null (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 | - |