Skip to content

feat(iam): add filtering on multiple IDs on listing endpoints #416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 10, 2024
Merged

feat(iam): add filtering on multiple IDs on listing endpoints #416

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions scaleway-async/scaleway_async/iam/v1alpha1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1206,6 +1206,7 @@ async def list_policies(
no_principal: Optional[bool] = None,
policy_name: Optional[str] = None,
tag: Optional[str] = None,
policy_ids: Optional[List[str]] = None,
) -> ListPoliciesResponse:
"""
List policies of an Organization.
Expand All @@ -1221,6 +1222,7 @@ async def list_policies(
:param no_principal: Defines whether or not the policy is attributed to a principal.
:param policy_name: Name of the policy to fetch.
:param tag: Filter by tags containing a given string.
:param policy_ids: Filter by a list of IDs.
:return: :class:`ListPoliciesResponse <ListPoliciesResponse>`
Usage:
Expand All @@ -1242,6 +1244,7 @@ async def list_policies(
or self.client.default_organization_id,
"page": page,
"page_size": page_size or self.client.default_page_size,
"policy_ids": policy_ids,
"policy_name": policy_name,
"tag": tag,
"user_ids": user_ids,
Expand All @@ -1265,6 +1268,7 @@ async def list_policies_all(
no_principal: Optional[bool] = None,
policy_name: Optional[str] = None,
tag: Optional[str] = None,
policy_ids: Optional[List[str]] = None,
) -> List[Policy]:
"""
List policies of an Organization.
Expand All @@ -1280,6 +1284,7 @@ async def list_policies_all(
:param no_principal: Defines whether or not the policy is attributed to a principal.
:param policy_name: Name of the policy to fetch.
:param tag: Filter by tags containing a given string.
:param policy_ids: Filter by a list of IDs.
:return: :class:`List[ListPoliciesResponse] <List[ListPoliciesResponse]>`
Usage:
Expand All @@ -1304,6 +1309,7 @@ async def list_policies_all(
"no_principal": no_principal,
"policy_name": policy_name,
"tag": tag,
"policy_ids": policy_ids,
},
)

Expand Down Expand Up @@ -1703,6 +1709,7 @@ async def list_api_keys(
description: Optional[str] = None,
bearer_id: Optional[str] = None,
bearer_type: BearerType = BearerType.UNKNOWN_BEARER_TYPE,
access_keys: Optional[List[str]] = None,
) -> ListAPIKeysResponse:
"""
List API keys.
Expand All @@ -1719,10 +1726,11 @@ async def list_api_keys(
One-of ('bearer'): at most one of 'application_id', 'user_id' could be set.
:param editable: Defines whether to filter out editable API keys or not.
:param expired: Defines whether to filter out expired API keys or not.
:param access_key: Filter by access key.
:param access_key: Filter by access key (deprecated in favor of `access_keys`).
:param description: Filter by description.
:param bearer_id: Filter by bearer ID.
:param bearer_type: Filter by type of bearer.
:param access_keys: Filter by a list of access keys.
:return: :class:`ListAPIKeysResponse <ListAPIKeysResponse>`
Usage:
Expand All @@ -1736,6 +1744,7 @@ async def list_api_keys(
f"/iam/v1alpha1/api-keys",
params={
"access_key": access_key,
"access_keys": access_keys,
"bearer_id": bearer_id,
"bearer_type": bearer_type,
"description": description,
Expand Down Expand Up @@ -1773,6 +1782,7 @@ async def list_api_keys_all(
description: Optional[str] = None,
bearer_id: Optional[str] = None,
bearer_type: Optional[BearerType] = None,
access_keys: Optional[List[str]] = None,
) -> List[APIKey]:
"""
List API keys.
Expand All @@ -1789,10 +1799,11 @@ async def list_api_keys_all(
One-of ('bearer'): at most one of 'application_id', 'user_id' could be set.
:param editable: Defines whether to filter out editable API keys or not.
:param expired: Defines whether to filter out expired API keys or not.
:param access_key: Filter by access key.
:param access_key: Filter by access key (deprecated in favor of `access_keys`).
:param description: Filter by description.
:param bearer_id: Filter by bearer ID.
:param bearer_type: Filter by type of bearer.
:param access_keys: Filter by a list of access keys.
:return: :class:`List[ListAPIKeysResponse] <List[ListAPIKeysResponse]>`
Usage:
Expand All @@ -1818,6 +1829,7 @@ async def list_api_keys_all(
"description": description,
"bearer_id": bearer_id,
"bearer_type": bearer_type,
"access_keys": access_keys,
},
)

Expand Down
13 changes: 12 additions & 1 deletion scaleway-async/scaleway_async/iam/v1alpha1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1493,6 +1493,11 @@ class ListPoliciesRequest:
Filter by tags containing a given string.
"""

policy_ids: Optional[List[str]]
"""
Filter by a list of IDs.
"""


@dataclass
class CreatePolicyRequest:
Expand Down Expand Up @@ -1726,7 +1731,8 @@ class ListAPIKeysRequest:

access_key: Optional[str]
"""
Filter by access key.
Filter by access key (deprecated in favor of `access_keys`).
:deprecated
"""

description: Optional[str]
Expand All @@ -1744,6 +1750,11 @@ class ListAPIKeysRequest:
Filter by type of bearer.
"""

access_keys: Optional[List[str]]
"""
Filter by a list of access keys.
"""


@dataclass
class CreateAPIKeyRequest:
Expand Down
16 changes: 14 additions & 2 deletions scaleway/scaleway/iam/v1alpha1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1206,6 +1206,7 @@ def list_policies(
no_principal: Optional[bool] = None,
policy_name: Optional[str] = None,
tag: Optional[str] = None,
policy_ids: Optional[List[str]] = None,
) -> ListPoliciesResponse:
"""
List policies of an Organization.
Expand All @@ -1221,6 +1222,7 @@ def list_policies(
:param no_principal: Defines whether or not the policy is attributed to a principal.
:param policy_name: Name of the policy to fetch.
:param tag: Filter by tags containing a given string.
:param policy_ids: Filter by a list of IDs.
:return: :class:`ListPoliciesResponse <ListPoliciesResponse>`

Usage:
Expand All @@ -1242,6 +1244,7 @@ def list_policies(
or self.client.default_organization_id,
"page": page,
"page_size": page_size or self.client.default_page_size,
"policy_ids": policy_ids,
"policy_name": policy_name,
"tag": tag,
"user_ids": user_ids,
Expand All @@ -1265,6 +1268,7 @@ def list_policies_all(
no_principal: Optional[bool] = None,
policy_name: Optional[str] = None,
tag: Optional[str] = None,
policy_ids: Optional[List[str]] = None,
) -> List[Policy]:
"""
List policies of an Organization.
Expand All @@ -1280,6 +1284,7 @@ def list_policies_all(
:param no_principal: Defines whether or not the policy is attributed to a principal.
:param policy_name: Name of the policy to fetch.
:param tag: Filter by tags containing a given string.
:param policy_ids: Filter by a list of IDs.
:return: :class:`List[ListPoliciesResponse] <List[ListPoliciesResponse]>`

Usage:
Expand All @@ -1304,6 +1309,7 @@ def list_policies_all(
"no_principal": no_principal,
"policy_name": policy_name,
"tag": tag,
"policy_ids": policy_ids,
},
)

Expand Down Expand Up @@ -1703,6 +1709,7 @@ def list_api_keys(
description: Optional[str] = None,
bearer_id: Optional[str] = None,
bearer_type: BearerType = BearerType.UNKNOWN_BEARER_TYPE,
access_keys: Optional[List[str]] = None,
) -> ListAPIKeysResponse:
"""
List API keys.
Expand All @@ -1719,10 +1726,11 @@ def list_api_keys(
One-of ('bearer'): at most one of 'application_id', 'user_id' could be set.
:param editable: Defines whether to filter out editable API keys or not.
:param expired: Defines whether to filter out expired API keys or not.
:param access_key: Filter by access key.
:param access_key: Filter by access key (deprecated in favor of `access_keys`).
:param description: Filter by description.
:param bearer_id: Filter by bearer ID.
:param bearer_type: Filter by type of bearer.
:param access_keys: Filter by a list of access keys.
:return: :class:`ListAPIKeysResponse <ListAPIKeysResponse>`

Usage:
Expand All @@ -1736,6 +1744,7 @@ def list_api_keys(
f"/iam/v1alpha1/api-keys",
params={
"access_key": access_key,
"access_keys": access_keys,
"bearer_id": bearer_id,
"bearer_type": bearer_type,
"description": description,
Expand Down Expand Up @@ -1773,6 +1782,7 @@ def list_api_keys_all(
description: Optional[str] = None,
bearer_id: Optional[str] = None,
bearer_type: Optional[BearerType] = None,
access_keys: Optional[List[str]] = None,
) -> List[APIKey]:
"""
List API keys.
Expand All @@ -1789,10 +1799,11 @@ def list_api_keys_all(
One-of ('bearer'): at most one of 'application_id', 'user_id' could be set.
:param editable: Defines whether to filter out editable API keys or not.
:param expired: Defines whether to filter out expired API keys or not.
:param access_key: Filter by access key.
:param access_key: Filter by access key (deprecated in favor of `access_keys`).
:param description: Filter by description.
:param bearer_id: Filter by bearer ID.
:param bearer_type: Filter by type of bearer.
:param access_keys: Filter by a list of access keys.
:return: :class:`List[ListAPIKeysResponse] <List[ListAPIKeysResponse]>`

Usage:
Expand All @@ -1818,6 +1829,7 @@ def list_api_keys_all(
"description": description,
"bearer_id": bearer_id,
"bearer_type": bearer_type,
"access_keys": access_keys,
},
)

Expand Down
13 changes: 12 additions & 1 deletion scaleway/scaleway/iam/v1alpha1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1493,6 +1493,11 @@ class ListPoliciesRequest:
Filter by tags containing a given string.
"""

policy_ids: Optional[List[str]]
"""
Filter by a list of IDs.
"""


@dataclass
class CreatePolicyRequest:
Expand Down Expand Up @@ -1726,7 +1731,8 @@ class ListAPIKeysRequest:

access_key: Optional[str]
"""
Filter by access key.
Filter by access key (deprecated in favor of `access_keys`).
:deprecated
"""

description: Optional[str]
Expand All @@ -1744,6 +1750,11 @@ class ListAPIKeysRequest:
Filter by type of bearer.
"""

access_keys: Optional[List[str]]
"""
Filter by a list of access keys.
"""


@dataclass
class CreateAPIKeyRequest:
Expand Down