Manage User Filters

1. Get All User Filters

The GET method returns all the user filters associated with the user as indicated by the userId path variable with an API token.

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location --request GET '{{url}}/api/access/{{userId}}/filters' \
--header 'Authorization: TOKEN {{token}}'

Response Example 

[
    {
        "id": "uken71i1tjfqmxkr",
        "name": "filter1",
        "filter": {
            "applications": [
                "test1"
            ],
            "associations": [
                "env1"
            ],
            "profiles": [
                "profile1"
            ],
            "statuses": [
                "status1"
            ],
            "applicationTypes": [
                "AWS1"
            ]
        }
    },
    {
        "id": "8cql35l1f53muixu",
        "name": "filter2",
        "filter": {
            "applications": [
                "test2"
            ],
            "associations": [
                "env2"
            ],
            "profiles": [
                "profile2"
            ],
            "statuses": [
                "status2"
            ],
            "applicationTypes": [
                "AWS2"
            ]
        }
    }
]

2. Create a User Filter

The POST method creates a user filter associated with the user as indicated by the userId path variable with an API token.

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location --request POST '{{url}}/api/access/{{userId}}/filters' \
--header 'Authorization: TOKEN {{token}}'
--header 'Content-Type: application/json' \
--data '{
	"name": "filter1",
	"filter": {
		"applications": [
			"test1"
		],
		"associations": [
			"env1"
		],
		"profiles": [
			"profile1"
		],
		"statuses": [
			"status1"
		],
		"applicationTypes": [
			"AWS1"
		]
	}
}'

Response Example 

{
    "id" : "6f926gwvmcxpvseg",
	"name": "filter1",
	"filter": {
		"applications": [
			"test1"
		],
		"associations": [
			"env1"
		],
		"profiles": [
			"profile1"
		],
		"statuses": [
			"status1"
		],
		"applicationTypes": [
			"AWS1"
		]
	}

3. Update a User Filter

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location --request PUT '{{url}}/api/access/{{userId}}/filters/{{filterId}}' \
--header 'Authorization: TOKEN {{token}}'
--header 'Content-Type: application/json' \
--data '{
	"name": "filter5",
	"filter": {
		"applications": [
			"test11"
		],
		"associations": [
			"env11"
		],
		"profiles": [
			"profile11"
		],
		"statuses": [
			"status11"
		],
		"applicationTypes": [
			"AWS11"
		]
	}
}'

Response Example 

4. Delete a User Filter

The DELETE method deletes an existing user filter associated with the user as indicated by the userId path variable with an API token.

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location --request DELETE '{{url}}/api/access/{{userId}}/filters/{{filterId}}' \
--header 'Authorization: TOKEN {{token}}'

Response Example