Method: projects.rules.list

Stay organized with collections Save and categorize content based on your preferences.

List all rules that are applied on transactions by the issuer switch. Rules can be filtered on API type and transaction type.

HTTP request

GET https://issuerswitch.googleapis.com/v1/{parent}/rules

Path parameters

Parameters
parent

string

Required. The parent resource must have the format of projects/{project}.

Query parameters

Parameters
pageSize

integer

The maximum number of rules to return. The service may return fewer than this value. If unspecified or if the specified value is less than 50, at most 50 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken

string

A page token, received from a previous ListRulesRequest call. Specify this parameter to retrieve the next page of rules.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response body for the rules.list method.

JSON representation
{
  "rules": [
    {
      object (Rule)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Fields
rules[]

object (Rule)

List of rules satisfying the specified filter criteria.

nextPageToken

string

Pass this token in a subsequent ListRulesRequest call to continue to list results. If all results have been returned, this field is an empty string or not present in the response.

totalSize

string (int64 format)

Total number of rules matching request criteria across all pages.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

IAM Permissions

Requires the following IAM permission on the parent resource:

  • issuerswitch.rules.list

For more information, see the IAM documentation.

Rule

A rule that is executed by the issuer switch while processing an API transaction.

JSON representation
{
  "name": string,
  "ruleDescription": string,
  "apiType": enum (ApiType),
  "transactionType": enum (TransactionType)
}
Fields
name

string

The unique identifier for this resource. Format: projects/{project}/rules/{rule}

ruleDescription

string

The description of the rule.

apiType

enum (ApiType)

The API Type for which this rule gets executed. A value of API_TYPE_UNSPECIFIED indicates that the rule is executed for all API transactions.

transactionType

enum (TransactionType)

The transaction type for which this rule gets executed. A value of TRANSACTION_TYPE_UNSPECIFIED indicates that the rule is executed for all transaction types.