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 authenticationFlowParms)

Create an authentication flow

Create an authentication flow. Caller requires the CONTEXTRULES:ADD permission.

Using the CreateAuthenticationFlowUsingPOSTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
authenticationFlowParms	AuthenticationFlowParms

Return type

AuthenticationFlow

Authorization

AdminAPIAuthentication

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 resourceRuleParms)

Create a resource rule

Create a resource rule for a specified resource. Caller requires the CONTEXTRULES:ADD permission.

Example

Using the CreateResourceRuleUsingPOSTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
resourceRuleParms	ResourceRuleParms

Return type

ResourceRule

Authorization

AdminAPIAuthentication

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 (string id)

Get an authentication flow

Get the specified authentication flow. Caller requires the CONTEXTRULES:VIEW permission.

Example

Using the GetAuthenticationFlowUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
id	string	The UUID of the authentication flow to be returned.

Return type

AuthenticationFlow

Authorization

AdminAPIAuthentication

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

Using the GetAuthenticationFlowsUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

This endpoint does not need any parameter.

Return type

List<AuthenticationFlow>

Authorization

AdminAPIAuthentication

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 (string id)

Get a resource rule

Get the specified resource rule. Caller requires the CONTEXTRULES:VIEW permission.

Example

Using the GetResourceRuleUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
id	string	The UUID of the resource rule to be returned.

Return type

ResourceRule

Authorization

AdminAPIAuthentication

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 (string id)

Get all resource rules for a resource

Get all resource rules for the specified resource. Caller requires the CONTEXTRULES:VIEW permission.

Example

Using the GetResourceRulesForResourceUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
id	string	The UUID of the resource whose resource rules are to be returned.

Return type

List<ResourceRule>

Authorization

AdminAPIAuthentication

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

Using the GetResourceRulesUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

This endpoint does not need any parameter.

Return type

List<ResourceRule>

Authorization

AdminAPIAuthentication

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

Using the GetTransactionRulesUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

This endpoint does not need any parameter.

Return type

List<TransactionRuleDescription>

Authorization

AdminAPIAuthentication

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 (string id)

Delete an authentication flow

Delete the specified authentication flow. Caller requires the CONTEXTRULES:REMOVE permission.

Example

Using the RemoveAuthenticationFlowUsingDELETEWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
id	string	The UUID of the authentication flow to be removed.

Return type

DeleteAuthenticationFlowResult

Authorization

AdminAPIAuthentication

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

void RemoveResourceRuleUsingDELETE (string id)

Delete a resource rule

Delete the specified resource rule. Caller requires the CONTEXTRULES:REMOVE permission.

Example

Using the RemoveResourceRuleUsingDELETEWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
id	string	The UUID of the resource rule to be removed.

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

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 (string id, AuthenticationFlowParms authenticationFlowParms)

Update an authentication flow

Update the specified authentication flow. Caller requires the CONTEXTRULES:EDIT permission.

Example

Using the UpdateAuthenticationFlowUsingPUTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
id	string	The UUID of the authentication flow to be modified.
authenticationFlowParms	AuthenticationFlowParms

Return type

AuthenticationFlow

Authorization

AdminAPIAuthentication

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

void UpdateResourceRuleUsingPUT (string id, ResourceRuleParms resourceRuleParms)

Update a resource rule

Update the specified resource rule. Caller requires the CONTEXTRULES:EDIT permission.

Example

Using the UpdateResourceRuleUsingPUTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
id	string	The UUID of the resource rule to be modified.
resourceRuleParms	ResourceRuleParms

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

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	-