diff --git a/scaleway-async/scaleway_async/iam/v1alpha1/api.py b/scaleway-async/scaleway_async/iam/v1alpha1/api.py index 0e8fb42bc..55d2e262f 100644 --- a/scaleway-async/scaleway_async/iam/v1alpha1/api.py +++ b/scaleway-async/scaleway_async/iam/v1alpha1/api.py @@ -114,14 +114,14 @@ async def list_ssh_keys( disabled: Optional[bool] = None, ) -> ListSSHKeysResponse: """ - List SSH keys - :param order_by: Sort order of SSH keys. - :param page: Requested page number. Value must be greater or equals to 1. + List SSH keys. By default, the SSH keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `organization_id`, `name`, `project_id` and `disabled`. + :param order_by: Sort order of the SSH keys. + :param page: Requested page number. Value must be greater or equal to 1. :param page_size: Number of items per page. Value must be between 1 and 100. - :param organization_id: Filter by organization ID. + :param organization_id: Filter by Organization ID. :param name: Name of group to find. - :param project_id: Filter by project ID. - :param disabled: Filter out disabled SSH keys or not. + :param project_id: Filter by Project ID. + :param disabled: Whether to include disabled SSH keys or not. :return: :class:`ListSSHKeysResponse ` Usage: @@ -160,14 +160,14 @@ async def list_ssh_keys_all( disabled: Optional[bool] = None, ) -> List[SSHKey]: """ - List SSH keys - :param order_by: Sort order of SSH keys. - :param page: Requested page number. Value must be greater or equals to 1. + List SSH keys. By default, the SSH keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `organization_id`, `name`, `project_id` and `disabled`. + :param order_by: Sort order of the SSH keys. + :param page: Requested page number. Value must be greater or equal to 1. :param page_size: Number of items per page. Value must be between 1 and 100. - :param organization_id: Filter by organization ID. + :param organization_id: Filter by Organization ID. :param name: Name of group to find. - :param project_id: Filter by project ID. - :param disabled: Filter out disabled SSH keys or not. + :param project_id: Filter by Project ID. + :param disabled: Whether to include disabled SSH keys or not. :return: :class:`List[ListSSHKeysResponse] ` Usage: @@ -199,10 +199,10 @@ async def create_ssh_key( project_id: Optional[str] = None, ) -> SSHKey: """ - Create an SSH key + Add a new SSH key to a Scaleway Project. You must specify the `name`, `public_key` and `project_id`. :param name: The name of the SSH key. Max length is 1000. - :param public_key: SSH public key. Currently ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported. Max length is 65000. - :param project_id: Project owning the resource. + :param public_key: SSH public key. Currently only the ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported. Max length is 65000. + :param project_id: Project the resource is attributed to. :return: :class:`SSHKey ` Usage: @@ -233,7 +233,7 @@ async def get_ssh_key( ssh_key_id: str, ) -> SSHKey: """ - Get an SSH key + Retrieve information about a given SSH key, specified by the `ssh_key_id` parameter. The SSH key's full details, including `id`, `name`, `public_key`, and `project_id` are returned in the response. :param ssh_key_id: The ID of the SSH key. :return: :class:`SSHKey ` @@ -261,7 +261,7 @@ async def update_ssh_key( disabled: Optional[bool] = None, ) -> SSHKey: """ - Update an SSH key + Update the parameters of an SSH key, including `name` and `disable`. :param ssh_key_id: :param name: Name of the SSH key. Max length is 1000. :param disabled: Enable or disable the SSH key. @@ -297,7 +297,7 @@ async def delete_ssh_key( ssh_key_id: str, ) -> Optional[None]: """ - Delete an SSH key + Delete a given SSH key, specified by the `ssh_key_id`. Deleting an SSH is permanent, and cannot be undone. Note that you might need to update any configurations that used the SSH key. :param ssh_key_id: Usage: @@ -326,12 +326,12 @@ async def list_users( user_ids: Optional[List[str]] = None, ) -> ListUsersResponse: """ - List users of an organization + List the users of an Organization. By default, the users listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `user_ids`. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater or equals to 1. - :param organization_id: ID of organization to filter. - :param user_ids: Filter out by a list of ID. + :param page: Page number. Value must be greater or equal to 1. + :param organization_id: ID of the Organization to filter. + :param user_ids: Filter by list of IDs. :return: :class:`ListUsersResponse ` Usage: @@ -366,12 +366,12 @@ async def list_users_all( user_ids: Optional[List[str]] = None, ) -> List[User]: """ - List users of an organization + List the users of an Organization. By default, the users listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `user_ids`. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater or equals to 1. - :param organization_id: ID of organization to filter. - :param user_ids: Filter out by a list of ID. + :param page: Page number. Value must be greater or equal to 1. + :param organization_id: ID of the Organization to filter. + :param user_ids: Filter by list of IDs. :return: :class:`List[ListUsersResponse] ` Usage: @@ -399,8 +399,8 @@ async def get_user( user_id: str, ) -> User: """ - Retrieve a user from its ID - :param user_id: ID of user to find. + Retrieve information about a user, specified by the `user_id` parameter. The user's full details, including `id`, `email`, `organization_id`, `status` and `two_factor_enabled` are returned in the response. + :param user_id: ID of the user to find. :return: :class:`User ` Usage: @@ -425,8 +425,8 @@ async def delete_user( user_id: str, ) -> Optional[None]: """ - Delete a guest user from an organization - :param user_id: ID of user to delete. + Remove a user from an Organization in which they are a guest. You must define the `user_id` in your request. Note that removing a user from an Organization automatically deletes their API keys, and any policies directly attached to them become orphaned. + :param user_id: ID of the user to delete. Usage: :: @@ -456,14 +456,14 @@ async def list_applications( application_ids: Optional[List[str]] = None, ) -> ListApplicationsResponse: """ - List applications of an organization + List the applications of an Organization. By default, the applications listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `application_ids`. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. - :param name: Name of application to filter. - :param organization_id: ID of organization to filter. - :param editable: Filter out editable applications or not. - :param application_ids: Filter out by a list of ID. + :param page: Page number. Value must be greater than 1. + :param name: Name of the application to filter. + :param organization_id: ID of the Organization to filter. + :param editable: Whether to filter out editable applications or not. + :param application_ids: Filter by list of IDs. :return: :class:`ListApplicationsResponse ` Usage: @@ -502,14 +502,14 @@ async def list_applications_all( application_ids: Optional[List[str]] = None, ) -> List[Application]: """ - List applications of an organization + List the applications of an Organization. By default, the applications listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `application_ids`. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. - :param name: Name of application to filter. - :param organization_id: ID of organization to filter. - :param editable: Filter out editable applications or not. - :param application_ids: Filter out by a list of ID. + :param page: Page number. Value must be greater than 1. + :param name: Name of the application to filter. + :param organization_id: ID of the Organization to filter. + :param editable: Whether to filter out editable applications or not. + :param application_ids: Filter by list of IDs. :return: :class:`List[ListApplicationsResponse] ` Usage: @@ -541,10 +541,10 @@ async def create_application( organization_id: Optional[str] = None, ) -> Application: """ - Create a new application - :param name: Name of application to create (max length is 64 chars). - :param organization_id: ID of organization. - :param description: Description of application (max length is 200 chars). + Create a new application. You must define the `name` parameter in the request. + :param name: Name of the application to create (max length is 64 characters). + :param organization_id: ID of the Organization. + :param description: Description of the application (max length is 200 characters). :return: :class:`Application ` Usage: @@ -575,8 +575,8 @@ async def get_application( application_id: str, ) -> Application: """ - Get an existing application - :param application_id: ID of application to find. + Retrieve information about an application, specified by the `application_id` parameter. The application's full details, including `id`, `email`, `organization_id`, `status` and `two_factor_enabled` are returned in the response. + :param application_id: ID of the application to find. :return: :class:`Application ` Usage: @@ -603,10 +603,10 @@ async def update_application( description: Optional[str] = None, ) -> Application: """ - Update an existing application - :param application_id: ID of application to update. - :param name: New name of application (max length is 64 chars). - :param description: New description of application (max length is 200 chars). + Update the parameters of an application, including `name` and `description`. + :param application_id: ID of the application to update. + :param name: New name for the application (max length is 64 chars). + :param description: New description for the application (max length is 200 chars). :return: :class:`Application ` Usage: @@ -639,8 +639,8 @@ async def delete_application( application_id: str, ) -> Optional[None]: """ - Delete an application - :param application_id: ID of application to delete. + Delete an application. Note that this action is irreversible and will automatically delete the application's API keys. Policies attached to users and applications via this group will no longer apply. + :param application_id: ID of the application to delete. Usage: :: @@ -671,15 +671,15 @@ async def list_groups( group_ids: Optional[List[str]] = None, ) -> ListGroupsResponse: """ - List groups + List groups. By default, the groups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters to filter your query. Use `user_ids` or `application_ids` to list all groups certain users or applications belong to. :param order_by: Sort order of groups. - :param page: Requested page number. Value must be greater or equals to 1. + :param page: Requested page number. Value must be greater or equal to 1. :param page_size: Number of items per page. Value must be between 1 and 100. - :param organization_id: Filter by organization ID. + :param organization_id: Filter by Organization ID. :param name: Name of group to find. - :param application_ids: Filter out by a list of application ID. - :param user_ids: Filter out by a list of user ID. - :param group_ids: Filter out by a list of group ID. + :param application_ids: Filter by a list of application IDs. + :param user_ids: Filter by a list of user IDs. + :param group_ids: Filter by a list of group IDs. :return: :class:`ListGroupsResponse ` Usage: @@ -720,15 +720,15 @@ async def list_groups_all( group_ids: Optional[List[str]] = None, ) -> List[Group]: """ - List groups + List groups. By default, the groups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters to filter your query. Use `user_ids` or `application_ids` to list all groups certain users or applications belong to. :param order_by: Sort order of groups. - :param page: Requested page number. Value must be greater or equals to 1. + :param page: Requested page number. Value must be greater or equal to 1. :param page_size: Number of items per page. Value must be between 1 and 100. - :param organization_id: Filter by organization ID. + :param organization_id: Filter by Organization ID. :param name: Name of group to find. - :param application_ids: Filter out by a list of application ID. - :param user_ids: Filter out by a list of user ID. - :param group_ids: Filter out by a list of group ID. + :param application_ids: Filter by a list of application IDs. + :param user_ids: Filter by a list of user IDs. + :param group_ids: Filter by a list of group IDs. :return: :class:`List[ListGroupsResponse] ` Usage: @@ -761,9 +761,9 @@ async def create_group( name: Optional[str] = None, ) -> Group: """ - Create a new group - :param organization_id: ID of organization linked to the group. - :param name: Name of the group to create (max length is 64 chars). MUST be unique inside an organization. + Create a new group. You must define the `name` and `organization_id` parameters in the request. + :param organization_id: ID of Organization linked to the group. + :param name: Name of the group to create (max length is 64 chars). MUST be unique inside an Organization. :param description: Description of the group to create (max length is 200 chars). :return: :class:`Group ` @@ -795,8 +795,8 @@ async def get_group( group_id: str, ) -> Group: """ - Get a group - :param group_id: ID of group. + Retrive information about a given group, specified by the `group_id` parameter. The group's full details, including `user_ids` and `application_ids` are returned in the response. + :param group_id: ID of the group. :return: :class:`Group ` Usage: @@ -823,9 +823,9 @@ async def update_group( description: Optional[str] = None, ) -> Group: """ - Update a group - :param group_id: ID of group to update. - :param name: New name for the group (max length is 64 chars). MUST be unique inside an organization. + Update the parameters of group, including `name` and `description`. + :param group_id: ID of the group to update. + :param name: New name for the group (max length is 64 chars). MUST be unique inside an Organization. :param description: New description for the group (max length is 200 chars). :return: :class:`Group ` @@ -861,7 +861,7 @@ async def set_group_members( application_ids: List[str], ) -> Group: """ - Overwrite users and applications of a group + Overwrite users and applications configuration in a group. Any information that you add using this command will overwrite the previous configuration. :param group_id: :param user_ids: :param application_ids: @@ -903,8 +903,8 @@ async def add_group_member( application_id: Optional[str] = None, ) -> Group: """ - Add a user of an application to a group - :param group_id: ID of group. + Add a user or an application to a group. You can specify a `user_id` and and `application_id` in the body of your request. Note that you can only add one of each per request. + :param group_id: ID of the group. :param user_id: ID of the user to add. One-of ('member'): at most one of 'user_id', 'application_id' could be set. @@ -945,8 +945,8 @@ async def remove_group_member( application_id: Optional[str] = None, ) -> Group: """ - Remove a user or an application from a group - :param group_id: ID of group. + Remove a user or an application from a group. You can specify a `user_id` and and `application_id` in the body of your request. Note that you can only remove one of each per request. Removing a user from a group means that any permissions given to them via the group (i.e. from an attached policy) will no longer apply. Be sure you want to remove these permissions from the user before proceeding. + :param group_id: ID of the group. :param user_id: ID of the user to remove. One-of ('member'): at most one of 'user_id', 'application_id' could be set. @@ -985,8 +985,8 @@ async def delete_group( group_id: str, ) -> Optional[None]: """ - Delete a group - :param group_id: ID of group to delete. + Delete a group. Note that this action is irreversible and could delete permissions for group members. Policies attached to users and applications via this group will no longer apply. + :param group_id: ID of the group to delete. Usage: :: @@ -1019,17 +1019,17 @@ async def list_policies( policy_name: Optional[str] = None, ) -> ListPoliciesResponse: """ - List policies of an organization + List the policies of an Organization. By default, the policies listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters to filter your query, such as `user_ids`, `groups_ids`, `application_ids`, and `policy_name`. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. - :param organization_id: ID of organization to filter. - :param editable: Filter out editable policies or not. - :param user_ids: Filter out by a list of user ID. - :param group_ids: Filter out by a list of group ID. - :param application_ids: Filter out by a list of application ID. - :param no_principal: True when the policy do not belong to any principal. - :param policy_name: Name of policy to fetch. + :param page: Page number. Value must be greater than 1. + :param organization_id: ID of the Organization to filter. + :param editable: Whether or not filter out editable policies. + :param user_ids: Whether or not to filter by list of user IDs. + :param group_ids: Whether or not to filter by list of group IDs. + :param application_ids: Filter by a list of application IDs. + :param no_principal: Whether or not the policy is attributed to a principal. + :param policy_name: Name of the policy to fetch. :return: :class:`ListPoliciesResponse ` Usage: @@ -1074,17 +1074,17 @@ async def list_policies_all( policy_name: Optional[str] = None, ) -> List[Policy]: """ - List policies of an organization + List the policies of an Organization. By default, the policies listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters to filter your query, such as `user_ids`, `groups_ids`, `application_ids`, and `policy_name`. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. - :param organization_id: ID of organization to filter. - :param editable: Filter out editable policies or not. - :param user_ids: Filter out by a list of user ID. - :param group_ids: Filter out by a list of group ID. - :param application_ids: Filter out by a list of application ID. - :param no_principal: True when the policy do not belong to any principal. - :param policy_name: Name of policy to fetch. + :param page: Page number. Value must be greater than 1. + :param organization_id: ID of the Organization to filter. + :param editable: Whether or not filter out editable policies. + :param user_ids: Whether or not to filter by list of user IDs. + :param group_ids: Whether or not to filter by list of group IDs. + :param application_ids: Filter by a list of application IDs. + :param no_principal: Whether or not the policy is attributed to a principal. + :param policy_name: Name of the policy to fetch. :return: :class:`List[ListPoliciesResponse] ` Usage: @@ -1124,21 +1124,21 @@ async def create_policy( no_principal: Optional[bool] = None, ) -> Policy: """ - Create a new policy - :param name: Name of policy to create (max length is 64 chars). - :param description: Description of policy to create (max length is 200 chars). - :param organization_id: ID of organization. + Create a new application. You must define the `name` parameter in the request. You can specify parameters such as `user_id`, `groups_id`, `application_id`, `no_principal`, `rules` and its child attributes. + :param name: Name of the policy to create (max length is 64 characters). + :param description: Description of the policy to create (max length is 200 characters). + :param organization_id: ID of the Organization. :param rules: Rules of the policy to create. - :param user_id: ID of user, owner of the policy. + :param user_id: ID of user attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. - :param group_id: ID of group, owner of the policy. + :param group_id: ID of group attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. - :param application_id: ID of application, owner of the policy. + :param application_id: ID of application attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. - :param no_principal: True when the policy do not belong to any principal. + :param no_principal: Whether or not a policy is attributed to a principal. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. :return: :class:`Policy ` @@ -1176,7 +1176,7 @@ async def get_policy( policy_id: str, ) -> Policy: """ - Get an existing policy + Retrieve information about a policy, speficified by the `policy_id` parameter. The policy's full details, including `id`, `name`, `organization_id`, `nb_rules` and `nb_scopes`, `nb_permission_sets` are returned in the response. :param policy_id: Id of policy to search. :return: :class:`Policy ` @@ -1208,20 +1208,20 @@ async def update_policy( no_principal: Optional[bool] = None, ) -> Policy: """ - Update an existing policy + Update the parameters of a policy, including `name`, `description`, `user_id`, `group_id`, `application_id` and `no_principal`. :param policy_id: Id of policy to update. - :param name: New name of policy (max length is 64 chars). - :param description: New description of policy (max length is 200 chars). - :param user_id: New ID of user, owner of the policy. + :param name: New name for the policy (max length is 64 characters). + :param description: New description of policy (max length is 200 characters). + :param user_id: New ID of user attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. - :param group_id: New ID of group, owner of the policy. + :param group_id: New ID of group attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. - :param application_id: New ID of application, owner of the policy. + :param application_id: New ID of application attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. - :param no_principal: True when the policy do not belong to any principal. + :param no_principal: Whether or not the policy is attributed to a principal. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. :return: :class:`Policy ` @@ -1260,7 +1260,7 @@ async def delete_policy( policy_id: str, ) -> Optional[None]: """ - Delete a policy + Delete a policy. You must define specify the `policy_id` parameter in your request. Note that when deleting a policy, all permissions it gives to its principal (user, group or application) will be revoked. :param policy_id: Id of policy to delete. Usage: @@ -1309,7 +1309,7 @@ async def set_rules( rules: List[RuleSpecs], ) -> SetRulesResponse: """ - Set rules of an existing policy + Overwrite the rules of a given policy. Any information that you add using this command will overwrite the previous configuration. If you include some of the rules you already had in your previous configuration in your new one, but you change their order, the new order of display will apply. While policy rules are ordered, they have no impact on the access logic of IAM because rules are allow-only. :param policy_id: Id of policy to update. :param rules: Rules of the policy to set. :return: :class:`SetRulesResponse ` @@ -1346,10 +1346,10 @@ async def list_rules( page: Optional[int] = None, ) -> ListRulesResponse: """ - List rules of an existing policy + List the rules of a given policy. By default, the rules listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `policy_id` in the query path of your request. :param policy_id: Id of policy to search. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. + :param page: Page number. Value must be greater than 1. :return: :class:`ListRulesResponse ` Usage: @@ -1379,10 +1379,10 @@ async def list_rules_all( page: Optional[int] = None, ) -> List[Rule]: """ - List rules of an existing policy + List the rules of a given policy. By default, the rules listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `policy_id` in the query path of your request. :param policy_id: Id of policy to search. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. + :param page: Page number. Value must be greater than 1. :return: :class:`List[ListRulesResponse] ` Usage: @@ -1411,11 +1411,11 @@ async def list_permission_sets( organization_id: Optional[str] = None, ) -> ListPermissionSetsResponse: """ - List permission sets + List permission sets available for given Organization. You must define the `organization_id` in the query path of your request. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. - :param organization_id: Filter by organization ID. + :param page: Page number. Value must be greater than 1. + :param organization_id: Filter by Organization ID. :return: :class:`ListPermissionSetsResponse ` Usage: @@ -1448,11 +1448,11 @@ async def list_permission_sets_all( organization_id: Optional[str] = None, ) -> List[PermissionSet]: """ - List permission sets + List permission sets available for given Organization. You must define the `organization_id` in the query path of your request. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. - :param organization_id: Filter by organization ID. + :param page: Page number. Value must be greater than 1. + :param organization_id: Filter by Organization ID. :return: :class:`List[ListPermissionSetsResponse] ` Usage: @@ -1490,23 +1490,23 @@ async def list_api_keys( bearer_type: BearerType = BearerType.UNKNOWN_BEARER_TYPE, ) -> ListAPIKeysResponse: """ - List API keys + List API keys. By default, the API keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `editable`, `expired`, `access_key` and `bearer_id`. :param order_by: Criteria for sorting results. - :param page: Number of page. Value must be greater or equals to 1. + :param page: Page number. Value must be greater or equal to 1. :param page_size: Number of results per page. Value must be between 1 and 100. - :param organization_id: ID of organization. - :param application_id: ID of an application bearer. + :param organization_id: ID of Organization. + :param application_id: ID of application that bears the API key. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. - :param user_id: ID of a user bearer. + :param user_id: ID of user that bears the API key. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. - :param editable: Filter out editable API keys or not. - :param expired: Filter out expired API keys or not. - :param access_key: Filter out by access key. - :param description: Filter out by description. - :param bearer_id: Filter out by bearer ID. - :param bearer_type: Filter out by type of bearer. + :param editable: Whether to filter out editable API keys or not. + :param expired: Whether to filter out expired API keys or not. + :param access_key: Filter by access key. + :param description: Filter by description. + :param bearer_id: Filter by bearer ID. + :param bearer_type: Filter by type of bearer. :return: :class:`ListAPIKeysResponse ` Usage: @@ -1559,23 +1559,23 @@ async def list_api_keys_all( bearer_type: Optional[BearerType] = None, ) -> List[APIKey]: """ - List API keys + List API keys. By default, the API keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `editable`, `expired`, `access_key` and `bearer_id`. :param order_by: Criteria for sorting results. - :param page: Number of page. Value must be greater or equals to 1. + :param page: Page number. Value must be greater or equal to 1. :param page_size: Number of results per page. Value must be between 1 and 100. - :param organization_id: ID of organization. - :param application_id: ID of an application bearer. + :param organization_id: ID of Organization. + :param application_id: ID of application that bears the API key. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. - :param user_id: ID of a user bearer. + :param user_id: ID of user that bears the API key. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. - :param editable: Filter out editable API keys or not. - :param expired: Filter out expired API keys or not. - :param access_key: Filter out by access key. - :param description: Filter out by description. - :param bearer_id: Filter out by bearer ID. - :param bearer_type: Filter out by type of bearer. + :param editable: Whether to filter out editable API keys or not. + :param expired: Whether to filter out expired API keys or not. + :param access_key: Filter by access key. + :param description: Filter by description. + :param bearer_id: Filter by bearer ID. + :param bearer_type: Filter by type of bearer. :return: :class:`List[ListAPIKeysResponse] ` Usage: @@ -1614,16 +1614,16 @@ async def create_api_key( default_project_id: Optional[str] = None, ) -> APIKey: """ - Create an API key - :param application_id: ID of application principal. + Create an API key. You must specify the `application_id` or the `user_id` and the description. You can also specify the `default_project_id` which is the Project ID of your preferred Project, to use with Object Storage. The `access_key` and `secret_key` values are returned in the response. Note that he secret key is only showed once. Make sure that you copy and store both keys somewhere safe. + :param application_id: ID of the application. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. - :param user_id: ID of user principal. + :param user_id: ID of the user. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. :param expires_at: Expiration date of the API key. - :param default_project_id: The default project ID to use with object storage. - :param description: The description of the API key (max length is 200 chars). + :param default_project_id: The default Project ID to use with Object Storage. + :param description: The description of the API key (max length is 200 characters). :return: :class:`APIKey ` Usage: @@ -1656,7 +1656,7 @@ async def get_api_key( access_key: str, ) -> APIKey: """ - Get an API key + Retrive information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation. :param access_key: Access key to search for. :return: :class:`APIKey ` @@ -1684,9 +1684,9 @@ async def update_api_key( description: Optional[str] = None, ) -> APIKey: """ - Update an API key + Update the parameters of an API key, including `default_project_id` and `description`. :param access_key: Access key to update. - :param default_project_id: The new default project ID to set. + :param default_project_id: The new default Project ID to set. :param description: The new description to update. :return: :class:`APIKey ` @@ -1720,7 +1720,7 @@ async def delete_api_key( access_key: str, ) -> Optional[None]: """ - Delete an API key + Delete an API key. Note that this action is irreversible and cannot be undone. Make sure you update any configurations using the API keys you delete. :param access_key: Access key to delete. Usage: @@ -1748,11 +1748,11 @@ async def list_quota( organization_id: Optional[str] = None, ) -> ListQuotaResponse: """ - List all quota in the organization with the associated limit + List all product and features quota for an Organization, with their associated limits. By default, the quota listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. - :param organization_id: Filter by organization ID. + :param page: Page number. Value must be greater than 1. + :param organization_id: Filter by Organization ID. :return: :class:`ListQuotaResponse ` Usage: @@ -1785,11 +1785,11 @@ async def list_quota_all( organization_id: Optional[str] = None, ) -> List[Quotum]: """ - List all quota in the organization with the associated limit + List all product and features quota for an Organization, with their associated limits. By default, the quota listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. - :param organization_id: Filter by organization ID. + :param page: Page number. Value must be greater than 1. + :param organization_id: Filter by Organization ID. :return: :class:`List[ListQuotaResponse] ` Usage: @@ -1817,9 +1817,9 @@ async def get_quotum( organization_id: Optional[str] = None, ) -> Quotum: """ - Get a quotum in the organization with the associated limit - :param quotum_name: Name of the quotum to get. - :param organization_id: ID of the organization. + Retrieve information about a resource quota, speficified by the `quotum_name` parameter. The quota's `limit`, or whether it is unlimited, is returned in the response. + :param quotum_name: Name of the quota to get. + :param organization_id: ID of the Organization. :return: :class:`Quotum ` Usage: @@ -1856,7 +1856,7 @@ async def list_jw_ts( :param order_by: Criteria for sorting results. :param audience_id: ID of the user to search. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. + :param page: Page number. Value must be greater to 1. :param expired: Filter out expired JWTs or not. :return: :class:`ListJWTsResponse ` @@ -1895,7 +1895,7 @@ async def list_jw_ts_all( :param order_by: Criteria for sorting results. :param audience_id: ID of the user to search. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. + :param page: Page number. Value must be greater to 1. :param expired: Filter out expired JWTs or not. :return: :class:`List[ListJWTsResponse] ` diff --git a/scaleway-async/scaleway_async/iam/v1alpha1/types.py b/scaleway-async/scaleway_async/iam/v1alpha1/types.py index 73d34126e..306e4d011 100644 --- a/scaleway-async/scaleway_async/iam/v1alpha1/types.py +++ b/scaleway-async/scaleway_async/iam/v1alpha1/types.py @@ -155,24 +155,24 @@ class APIKey: access_key: str """ - Access key of API key. + Access key of the API key. """ secret_key: Optional[str] """ - Secret key of API Key. + Secret key of the API Key. """ application_id: Optional[str] """ - ID of application bearer. + ID of application that bears the API key. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. """ user_id: Optional[str] """ - ID of user bearer. + ID of user that bears the API key. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. """ @@ -184,22 +184,22 @@ class APIKey: created_at: Optional[datetime] """ - Creation date and time of API key. + Date and time of API key creation. """ updated_at: Optional[datetime] """ - Last update date and time of API key. + Date and time of last API key update. """ expires_at: Optional[datetime] """ - Expiration date and time of API key. + Date and time of API key expiration. """ default_project_id: str """ - The default project ID specified for this API key. + The default Project ID specified for this API key. """ editable: bool @@ -209,7 +209,7 @@ class APIKey: creation_ip: str """ - IP Address of the device which created the API key. + IP address of the device that created the API key. """ @@ -221,12 +221,12 @@ class Application: id: str """ - ID of application. + ID of the application. """ name: str """ - Name of application. + Name of the application. """ description: str @@ -236,17 +236,17 @@ class Application: created_at: Optional[datetime] """ - Creation date of application. + Date and time application was created. """ updated_at: Optional[datetime] """ - Last update date of application. + Date and time of last application update. """ organization_id: str """ - ID of organization. + ID of the Organization. """ editable: bool @@ -256,7 +256,7 @@ class Application: nb_api_keys: int """ - Number of API keys owned by the application. + Number of API keys attributed to the application. """ @@ -268,27 +268,27 @@ class Group: id: str """ - ID of group. + ID of the group. """ created_at: Optional[datetime] """ - Creation date and time of group. + Date and time of group creation. """ updated_at: Optional[datetime] """ - Last update date and time of group. + Date and time of last group update. """ organization_id: str """ - ID of organization linked to the group. + ID of Organization linked to the group. """ name: str """ - Name of group. + Name of the group. """ description: str @@ -522,27 +522,27 @@ class PermissionSet: id: str """ - Id of permission set. + Id of the permission set. """ name: str """ - Name of permission set. + Name of the permission set. """ scope_type: PermissionSetScopeType """ - Scope of permission set. + Scope of the permission set. """ description: str """ - Description of permission set. + Description of the permission set. """ categories: Optional[List[str]] """ - Categories of permission set. + Categories of the permission set. """ @@ -554,78 +554,78 @@ class Policy: id: str """ - Id of policy. + Id of the policy. """ name: str """ - Name of policy. + Name of the policy. """ description: str """ - Description of policy. + Description of the policy. """ organization_id: str """ - Organization ID of policy. + Organization ID of the policy. """ created_at: Optional[datetime] """ - Creation date and time of policy. + Date and time of policy creation. """ updated_at: Optional[datetime] """ - Last update date and time of policy. + Date and time of last policy update. """ editable: bool """ - Editable status of policy. + Whether or not a policy is editable. """ nb_rules: int """ - Number of rules of policy. + Number of rules of the policy. """ nb_scopes: int """ - Number of scopes of policy. + Number of policy scopes. """ nb_permission_sets: int """ - Number of permission sets of policy. + Number of permission sets of the policy. """ user_id: Optional[str] """ - ID of user, owner of the policy. + ID of the user attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ group_id: Optional[str] """ - ID of group, owner of the policy. + ID of the group attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ application_id: Optional[str] """ - ID of application, owner of the policy. + ID of the application attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ no_principal: Optional[bool] """ - True when the policy do not belong to any principal. + Whether or not a policy is attributed to a principal. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ @@ -639,19 +639,19 @@ class Quotum: name: str """ - Name of the quotum. + Name of the quota. """ limit: Optional[int] """ - Max limit of the quotum. + Maximum limit of the quota. One-of ('value'): at most one of 'limit', 'unlimited' could be set. """ unlimited: Optional[bool] """ - Whether the quotum is unlimited or not. + Whether or not the quota is unlimited. One-of ('value'): at most one of 'limit', 'unlimited' could be set. """ @@ -680,21 +680,21 @@ class Rule: project_ids: Optional[List[str]] """ - List of project IDs scoped to the rule. + List of Project IDs the rule is scoped to. One-of ('scope'): at most one of 'project_ids', 'organization_id', 'account_root_user_id' could be set. """ organization_id: Optional[str] """ - ID of organization scoped to the rule. + ID of Organization the rule is scoped to. One-of ('scope'): at most one of 'project_ids', 'organization_id', 'account_root_user_id' could be set. """ account_root_user_id: Optional[str] """ - ID of account root user scoped to the rule. + ID of account root user the rule is scoped to. One-of ('scope'): at most one of 'project_ids', 'organization_id', 'account_root_user_id' could be set. """ @@ -713,14 +713,14 @@ class RuleSpecs: project_ids: Optional[List[str]] """ - List of project IDs scoped to the rule. + List of Project IDs the rule is scoped to. One-of ('scope'): at most one of 'project_ids', 'organization_id' could be set. """ organization_id: Optional[str] """ - ID of organization scoped to the rule. + ID of Organization the rule is scoped to. One-of ('scope'): at most one of 'project_ids', 'organization_id' could be set. """ @@ -749,7 +749,7 @@ class SSHKey: fingerprint: str """ - Fingerprint of SSH key. + Fingerprint of the SSH key. """ created_at: Optional[datetime] @@ -764,12 +764,12 @@ class SSHKey: organization_id: str """ - ID of organization linked to the SSH key. + ID of Organization linked to the SSH key. """ project_id: str """ - ID of project linked to the SSH key. + ID of Project linked to the SSH key. """ disabled: bool @@ -786,7 +786,7 @@ class SetRulesResponse: rules: List[Rule] """ - Rules of policy. + Rules of the policy. """ @@ -808,42 +808,42 @@ class User: created_at: Optional[datetime] """ - Creation date of user. + Date user was created. """ updated_at: Optional[datetime] """ - Last update date of user. + Date of last user update. """ organization_id: str """ - ID of organization. + ID of the Organization. """ deletable: bool """ - Deletion status of user. Owner user cannot be deleted. + Deletion status of user. Owners cannot be deleted. """ last_login_at: Optional[datetime] """ - Last login date. + Date of the last login. """ type_: UserType """ - Type of the user. + Type of user. """ two_factor_enabled: bool """ - 2FA enabled. + Whether MFA is enabled. """ status: UserStatus """ - Status of invitation for the user. + Status of user invitation. """ @@ -851,12 +851,12 @@ class User: class ListSSHKeysRequest: order_by: Optional[ListSSHKeysRequestOrderBy] """ - Sort order of SSH keys. + Sort order of the SSH keys. """ page: Optional[int] """ - Requested page number. Value must be greater or equals to 1. + Requested page number. Value must be greater or equal to 1. """ page_size: Optional[int] @@ -866,7 +866,7 @@ class ListSSHKeysRequest: organization_id: Optional[str] """ - Filter by organization ID. + Filter by Organization ID. """ name: Optional[str] @@ -876,12 +876,12 @@ class ListSSHKeysRequest: project_id: Optional[str] """ - Filter by project ID. + Filter by Project ID. """ disabled: Optional[bool] """ - Filter out disabled SSH keys or not. + Whether to include disabled SSH keys or not. """ @@ -894,12 +894,12 @@ class CreateSSHKeyRequest: public_key: str """ - SSH public key. Currently ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported. Max length is 65000. + SSH public key. Currently only the ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported. Max length is 65000. """ project_id: Optional[str] """ - Project owning the resource. + Project the resource is attributed to. """ @@ -945,17 +945,17 @@ class ListUsersRequest: page: Optional[int] """ - Number of page. Value must be greater or equals to 1. + Page number. Value must be greater or equal to 1. """ organization_id: Optional[str] """ - ID of organization to filter. + ID of the Organization to filter. """ user_ids: Optional[List[str]] """ - Filter out by a list of ID. + Filter by list of IDs. """ @@ -963,7 +963,7 @@ class ListUsersRequest: class GetUserRequest: user_id: str """ - ID of user to find. + ID of the user to find. """ @@ -971,7 +971,7 @@ class GetUserRequest: class DeleteUserRequest: user_id: str """ - ID of user to delete. + ID of the user to delete. """ @@ -989,27 +989,27 @@ class ListApplicationsRequest: page: Optional[int] """ - Number of page. Value must be greater to 1. + Page number. Value must be greater than 1. """ name: Optional[str] """ - Name of application to filter. + Name of the application to filter. """ organization_id: Optional[str] """ - ID of organization to filter. + ID of the Organization to filter. """ editable: Optional[bool] """ - Filter out editable applications or not. + Whether to filter out editable applications or not. """ application_ids: Optional[List[str]] """ - Filter out by a list of ID. + Filter by list of IDs. """ @@ -1017,17 +1017,17 @@ class ListApplicationsRequest: class CreateApplicationRequest: name: Optional[str] """ - Name of application to create (max length is 64 chars). + Name of the application to create (max length is 64 characters). """ organization_id: Optional[str] """ - ID of organization. + ID of the Organization. """ description: str """ - Description of application (max length is 200 chars). + Description of the application (max length is 200 characters). """ @@ -1035,7 +1035,7 @@ class CreateApplicationRequest: class GetApplicationRequest: application_id: str """ - ID of application to find. + ID of the application to find. """ @@ -1043,17 +1043,17 @@ class GetApplicationRequest: class UpdateApplicationRequest: application_id: str """ - ID of application to update. + ID of the application to update. """ name: Optional[str] """ - New name of application (max length is 64 chars). + New name for the application (max length is 64 chars). """ description: Optional[str] """ - New description of application (max length is 200 chars). + New description for the application (max length is 200 chars). """ @@ -1061,7 +1061,7 @@ class UpdateApplicationRequest: class DeleteApplicationRequest: application_id: str """ - ID of application to delete. + ID of the application to delete. """ @@ -1074,7 +1074,7 @@ class ListGroupsRequest: page: Optional[int] """ - Requested page number. Value must be greater or equals to 1. + Requested page number. Value must be greater or equal to 1. """ page_size: Optional[int] @@ -1084,7 +1084,7 @@ class ListGroupsRequest: organization_id: Optional[str] """ - Filter by organization ID. + Filter by Organization ID. """ name: Optional[str] @@ -1094,17 +1094,17 @@ class ListGroupsRequest: application_ids: Optional[List[str]] """ - Filter out by a list of application ID. + Filter by a list of application IDs. """ user_ids: Optional[List[str]] """ - Filter out by a list of user ID. + Filter by a list of user IDs. """ group_ids: Optional[List[str]] """ - Filter out by a list of group ID. + Filter by a list of group IDs. """ @@ -1112,12 +1112,12 @@ class ListGroupsRequest: class CreateGroupRequest: organization_id: Optional[str] """ - ID of organization linked to the group. + ID of Organization linked to the group. """ name: Optional[str] """ - Name of the group to create (max length is 64 chars). MUST be unique inside an organization. + Name of the group to create (max length is 64 chars). MUST be unique inside an Organization. """ description: str @@ -1130,7 +1130,7 @@ class CreateGroupRequest: class GetGroupRequest: group_id: str """ - ID of group. + ID of the group. """ @@ -1138,12 +1138,12 @@ class GetGroupRequest: class UpdateGroupRequest: group_id: str """ - ID of group to update. + ID of the group to update. """ name: Optional[str] """ - New name for the group (max length is 64 chars). MUST be unique inside an organization. + New name for the group (max length is 64 chars). MUST be unique inside an Organization. """ description: Optional[str] @@ -1165,7 +1165,7 @@ class SetGroupMembersRequest: class AddGroupMemberRequest: group_id: str """ - ID of group. + ID of the group. """ user_id: Optional[str] @@ -1187,7 +1187,7 @@ class AddGroupMemberRequest: class RemoveGroupMemberRequest: group_id: str """ - ID of group. + ID of the group. """ user_id: Optional[str] @@ -1209,7 +1209,7 @@ class RemoveGroupMemberRequest: class DeleteGroupRequest: group_id: str """ - ID of group to delete. + ID of the group to delete. """ @@ -1227,42 +1227,42 @@ class ListPoliciesRequest: page: Optional[int] """ - Number of page. Value must be greater to 1. + Page number. Value must be greater than 1. """ organization_id: Optional[str] """ - ID of organization to filter. + ID of the Organization to filter. """ editable: Optional[bool] """ - Filter out editable policies or not. + Whether or not filter out editable policies. """ user_ids: Optional[List[str]] """ - Filter out by a list of user ID. + Whether or not to filter by list of user IDs. """ group_ids: Optional[List[str]] """ - Filter out by a list of group ID. + Whether or not to filter by list of group IDs. """ application_ids: Optional[List[str]] """ - Filter out by a list of application ID. + Filter by a list of application IDs. """ no_principal: Optional[bool] """ - True when the policy do not belong to any principal. + Whether or not the policy is attributed to a principal. """ policy_name: Optional[str] """ - Name of policy to fetch. + Name of the policy to fetch. """ @@ -1270,17 +1270,17 @@ class ListPoliciesRequest: class CreatePolicyRequest: name: Optional[str] """ - Name of policy to create (max length is 64 chars). + Name of the policy to create (max length is 64 characters). """ description: str """ - Description of policy to create (max length is 200 chars). + Description of the policy to create (max length is 200 characters). """ organization_id: Optional[str] """ - ID of organization. + ID of the Organization. """ rules: Optional[List[RuleSpecs]] @@ -1290,28 +1290,28 @@ class CreatePolicyRequest: user_id: Optional[str] """ - ID of user, owner of the policy. + ID of user attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ group_id: Optional[str] """ - ID of group, owner of the policy. + ID of group attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ application_id: Optional[str] """ - ID of application, owner of the policy. + ID of application attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ no_principal: Optional[bool] """ - True when the policy do not belong to any principal. + Whether or not a policy is attributed to a principal. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ @@ -1334,38 +1334,38 @@ class UpdatePolicyRequest: name: Optional[str] """ - New name of policy (max length is 64 chars). + New name for the policy (max length is 64 characters). """ description: Optional[str] """ - New description of policy (max length is 200 chars). + New description of policy (max length is 200 characters). """ user_id: Optional[str] """ - New ID of user, owner of the policy. + New ID of user attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ group_id: Optional[str] """ - New ID of group, owner of the policy. + New ID of group attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ application_id: Optional[str] """ - New ID of application, owner of the policy. + New ID of application attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ no_principal: Optional[bool] """ - True when the policy do not belong to any principal. + Whether or not the policy is attributed to a principal. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ @@ -1411,7 +1411,7 @@ class ListRulesRequest: page: Optional[int] """ - Number of page. Value must be greater to 1. + Page number. Value must be greater than 1. """ @@ -1429,12 +1429,12 @@ class ListPermissionSetsRequest: page: Optional[int] """ - Number of page. Value must be greater to 1. + Page number. Value must be greater than 1. """ organization_id: Optional[str] """ - Filter by organization ID. + Filter by Organization ID. """ @@ -1447,7 +1447,7 @@ class ListAPIKeysRequest: page: Optional[int] """ - Number of page. Value must be greater or equals to 1. + Page number. Value must be greater or equal to 1. """ page_size: Optional[int] @@ -1457,12 +1457,12 @@ class ListAPIKeysRequest: organization_id: Optional[str] """ - ID of organization. + ID of Organization. """ application_id: Optional[str] """ - ID of an application bearer. + ID of application that bears the API key. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. :deprecated @@ -1470,7 +1470,7 @@ class ListAPIKeysRequest: user_id: Optional[str] """ - ID of a user bearer. + ID of user that bears the API key. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. :deprecated @@ -1478,32 +1478,32 @@ class ListAPIKeysRequest: editable: Optional[bool] """ - Filter out editable API keys or not. + Whether to filter out editable API keys or not. """ expired: Optional[bool] """ - Filter out expired API keys or not. + Whether to filter out expired API keys or not. """ access_key: Optional[str] """ - Filter out by access key. + Filter by access key. """ description: Optional[str] """ - Filter out by description. + Filter by description. """ bearer_id: Optional[str] """ - Filter out by bearer ID. + Filter by bearer ID. """ bearer_type: Optional[BearerType] """ - Filter out by type of bearer. + Filter by type of bearer. """ @@ -1511,14 +1511,14 @@ class ListAPIKeysRequest: class CreateAPIKeyRequest: application_id: Optional[str] """ - ID of application principal. + ID of the application. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. """ user_id: Optional[str] """ - ID of user principal. + ID of the user. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. """ @@ -1530,12 +1530,12 @@ class CreateAPIKeyRequest: default_project_id: Optional[str] """ - The default project ID to use with object storage. + The default Project ID to use with Object Storage. """ description: str """ - The description of the API key (max length is 200 chars). + The description of the API key (max length is 200 characters). """ @@ -1556,7 +1556,7 @@ class UpdateAPIKeyRequest: default_project_id: Optional[str] """ - The new default project ID to set. + The new default Project ID to set. """ description: Optional[str] @@ -1587,12 +1587,12 @@ class ListQuotaRequest: page: Optional[int] """ - Number of page. Value must be greater to 1. + Page number. Value must be greater than 1. """ organization_id: Optional[str] """ - Filter by organization ID. + Filter by Organization ID. """ @@ -1600,12 +1600,12 @@ class ListQuotaRequest: class GetQuotumRequest: quotum_name: str """ - Name of the quotum to get. + Name of the quota to get. """ organization_id: Optional[str] """ - ID of the organization. + ID of the Organization. """ @@ -1628,7 +1628,7 @@ class ListJWTsRequest: page: Optional[int] """ - Number of page. Value must be greater to 1. + Page number. Value must be greater to 1. """ expired: Optional[bool] diff --git a/scaleway/scaleway/iam/v1alpha1/api.py b/scaleway/scaleway/iam/v1alpha1/api.py index c9c3ee39d..958d885c4 100644 --- a/scaleway/scaleway/iam/v1alpha1/api.py +++ b/scaleway/scaleway/iam/v1alpha1/api.py @@ -114,14 +114,14 @@ def list_ssh_keys( disabled: Optional[bool] = None, ) -> ListSSHKeysResponse: """ - List SSH keys - :param order_by: Sort order of SSH keys. - :param page: Requested page number. Value must be greater or equals to 1. + List SSH keys. By default, the SSH keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `organization_id`, `name`, `project_id` and `disabled`. + :param order_by: Sort order of the SSH keys. + :param page: Requested page number. Value must be greater or equal to 1. :param page_size: Number of items per page. Value must be between 1 and 100. - :param organization_id: Filter by organization ID. + :param organization_id: Filter by Organization ID. :param name: Name of group to find. - :param project_id: Filter by project ID. - :param disabled: Filter out disabled SSH keys or not. + :param project_id: Filter by Project ID. + :param disabled: Whether to include disabled SSH keys or not. :return: :class:`ListSSHKeysResponse ` Usage: @@ -160,14 +160,14 @@ def list_ssh_keys_all( disabled: Optional[bool] = None, ) -> List[SSHKey]: """ - List SSH keys - :param order_by: Sort order of SSH keys. - :param page: Requested page number. Value must be greater or equals to 1. + List SSH keys. By default, the SSH keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `organization_id`, `name`, `project_id` and `disabled`. + :param order_by: Sort order of the SSH keys. + :param page: Requested page number. Value must be greater or equal to 1. :param page_size: Number of items per page. Value must be between 1 and 100. - :param organization_id: Filter by organization ID. + :param organization_id: Filter by Organization ID. :param name: Name of group to find. - :param project_id: Filter by project ID. - :param disabled: Filter out disabled SSH keys or not. + :param project_id: Filter by Project ID. + :param disabled: Whether to include disabled SSH keys or not. :return: :class:`List[ListSSHKeysResponse] ` Usage: @@ -199,10 +199,10 @@ def create_ssh_key( project_id: Optional[str] = None, ) -> SSHKey: """ - Create an SSH key + Add a new SSH key to a Scaleway Project. You must specify the `name`, `public_key` and `project_id`. :param name: The name of the SSH key. Max length is 1000. - :param public_key: SSH public key. Currently ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported. Max length is 65000. - :param project_id: Project owning the resource. + :param public_key: SSH public key. Currently only the ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported. Max length is 65000. + :param project_id: Project the resource is attributed to. :return: :class:`SSHKey ` Usage: @@ -233,7 +233,7 @@ def get_ssh_key( ssh_key_id: str, ) -> SSHKey: """ - Get an SSH key + Retrieve information about a given SSH key, specified by the `ssh_key_id` parameter. The SSH key's full details, including `id`, `name`, `public_key`, and `project_id` are returned in the response. :param ssh_key_id: The ID of the SSH key. :return: :class:`SSHKey ` @@ -261,7 +261,7 @@ def update_ssh_key( disabled: Optional[bool] = None, ) -> SSHKey: """ - Update an SSH key + Update the parameters of an SSH key, including `name` and `disable`. :param ssh_key_id: :param name: Name of the SSH key. Max length is 1000. :param disabled: Enable or disable the SSH key. @@ -297,7 +297,7 @@ def delete_ssh_key( ssh_key_id: str, ) -> Optional[None]: """ - Delete an SSH key + Delete a given SSH key, specified by the `ssh_key_id`. Deleting an SSH is permanent, and cannot be undone. Note that you might need to update any configurations that used the SSH key. :param ssh_key_id: Usage: @@ -326,12 +326,12 @@ def list_users( user_ids: Optional[List[str]] = None, ) -> ListUsersResponse: """ - List users of an organization + List the users of an Organization. By default, the users listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `user_ids`. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater or equals to 1. - :param organization_id: ID of organization to filter. - :param user_ids: Filter out by a list of ID. + :param page: Page number. Value must be greater or equal to 1. + :param organization_id: ID of the Organization to filter. + :param user_ids: Filter by list of IDs. :return: :class:`ListUsersResponse ` Usage: @@ -366,12 +366,12 @@ def list_users_all( user_ids: Optional[List[str]] = None, ) -> List[User]: """ - List users of an organization + List the users of an Organization. By default, the users listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `user_ids`. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater or equals to 1. - :param organization_id: ID of organization to filter. - :param user_ids: Filter out by a list of ID. + :param page: Page number. Value must be greater or equal to 1. + :param organization_id: ID of the Organization to filter. + :param user_ids: Filter by list of IDs. :return: :class:`List[ListUsersResponse] ` Usage: @@ -399,8 +399,8 @@ def get_user( user_id: str, ) -> User: """ - Retrieve a user from its ID - :param user_id: ID of user to find. + Retrieve information about a user, specified by the `user_id` parameter. The user's full details, including `id`, `email`, `organization_id`, `status` and `two_factor_enabled` are returned in the response. + :param user_id: ID of the user to find. :return: :class:`User ` Usage: @@ -425,8 +425,8 @@ def delete_user( user_id: str, ) -> Optional[None]: """ - Delete a guest user from an organization - :param user_id: ID of user to delete. + Remove a user from an Organization in which they are a guest. You must define the `user_id` in your request. Note that removing a user from an Organization automatically deletes their API keys, and any policies directly attached to them become orphaned. + :param user_id: ID of the user to delete. Usage: :: @@ -456,14 +456,14 @@ def list_applications( application_ids: Optional[List[str]] = None, ) -> ListApplicationsResponse: """ - List applications of an organization + List the applications of an Organization. By default, the applications listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `application_ids`. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. - :param name: Name of application to filter. - :param organization_id: ID of organization to filter. - :param editable: Filter out editable applications or not. - :param application_ids: Filter out by a list of ID. + :param page: Page number. Value must be greater than 1. + :param name: Name of the application to filter. + :param organization_id: ID of the Organization to filter. + :param editable: Whether to filter out editable applications or not. + :param application_ids: Filter by list of IDs. :return: :class:`ListApplicationsResponse ` Usage: @@ -502,14 +502,14 @@ def list_applications_all( application_ids: Optional[List[str]] = None, ) -> List[Application]: """ - List applications of an organization + List the applications of an Organization. By default, the applications listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `application_ids`. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. - :param name: Name of application to filter. - :param organization_id: ID of organization to filter. - :param editable: Filter out editable applications or not. - :param application_ids: Filter out by a list of ID. + :param page: Page number. Value must be greater than 1. + :param name: Name of the application to filter. + :param organization_id: ID of the Organization to filter. + :param editable: Whether to filter out editable applications or not. + :param application_ids: Filter by list of IDs. :return: :class:`List[ListApplicationsResponse] ` Usage: @@ -541,10 +541,10 @@ def create_application( organization_id: Optional[str] = None, ) -> Application: """ - Create a new application - :param name: Name of application to create (max length is 64 chars). - :param organization_id: ID of organization. - :param description: Description of application (max length is 200 chars). + Create a new application. You must define the `name` parameter in the request. + :param name: Name of the application to create (max length is 64 characters). + :param organization_id: ID of the Organization. + :param description: Description of the application (max length is 200 characters). :return: :class:`Application ` Usage: @@ -575,8 +575,8 @@ def get_application( application_id: str, ) -> Application: """ - Get an existing application - :param application_id: ID of application to find. + Retrieve information about an application, specified by the `application_id` parameter. The application's full details, including `id`, `email`, `organization_id`, `status` and `two_factor_enabled` are returned in the response. + :param application_id: ID of the application to find. :return: :class:`Application ` Usage: @@ -603,10 +603,10 @@ def update_application( description: Optional[str] = None, ) -> Application: """ - Update an existing application - :param application_id: ID of application to update. - :param name: New name of application (max length is 64 chars). - :param description: New description of application (max length is 200 chars). + Update the parameters of an application, including `name` and `description`. + :param application_id: ID of the application to update. + :param name: New name for the application (max length is 64 chars). + :param description: New description for the application (max length is 200 chars). :return: :class:`Application ` Usage: @@ -639,8 +639,8 @@ def delete_application( application_id: str, ) -> Optional[None]: """ - Delete an application - :param application_id: ID of application to delete. + Delete an application. Note that this action is irreversible and will automatically delete the application's API keys. Policies attached to users and applications via this group will no longer apply. + :param application_id: ID of the application to delete. Usage: :: @@ -671,15 +671,15 @@ def list_groups( group_ids: Optional[List[str]] = None, ) -> ListGroupsResponse: """ - List groups + List groups. By default, the groups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters to filter your query. Use `user_ids` or `application_ids` to list all groups certain users or applications belong to. :param order_by: Sort order of groups. - :param page: Requested page number. Value must be greater or equals to 1. + :param page: Requested page number. Value must be greater or equal to 1. :param page_size: Number of items per page. Value must be between 1 and 100. - :param organization_id: Filter by organization ID. + :param organization_id: Filter by Organization ID. :param name: Name of group to find. - :param application_ids: Filter out by a list of application ID. - :param user_ids: Filter out by a list of user ID. - :param group_ids: Filter out by a list of group ID. + :param application_ids: Filter by a list of application IDs. + :param user_ids: Filter by a list of user IDs. + :param group_ids: Filter by a list of group IDs. :return: :class:`ListGroupsResponse ` Usage: @@ -720,15 +720,15 @@ def list_groups_all( group_ids: Optional[List[str]] = None, ) -> List[Group]: """ - List groups + List groups. By default, the groups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters to filter your query. Use `user_ids` or `application_ids` to list all groups certain users or applications belong to. :param order_by: Sort order of groups. - :param page: Requested page number. Value must be greater or equals to 1. + :param page: Requested page number. Value must be greater or equal to 1. :param page_size: Number of items per page. Value must be between 1 and 100. - :param organization_id: Filter by organization ID. + :param organization_id: Filter by Organization ID. :param name: Name of group to find. - :param application_ids: Filter out by a list of application ID. - :param user_ids: Filter out by a list of user ID. - :param group_ids: Filter out by a list of group ID. + :param application_ids: Filter by a list of application IDs. + :param user_ids: Filter by a list of user IDs. + :param group_ids: Filter by a list of group IDs. :return: :class:`List[ListGroupsResponse] ` Usage: @@ -761,9 +761,9 @@ def create_group( name: Optional[str] = None, ) -> Group: """ - Create a new group - :param organization_id: ID of organization linked to the group. - :param name: Name of the group to create (max length is 64 chars). MUST be unique inside an organization. + Create a new group. You must define the `name` and `organization_id` parameters in the request. + :param organization_id: ID of Organization linked to the group. + :param name: Name of the group to create (max length is 64 chars). MUST be unique inside an Organization. :param description: Description of the group to create (max length is 200 chars). :return: :class:`Group ` @@ -795,8 +795,8 @@ def get_group( group_id: str, ) -> Group: """ - Get a group - :param group_id: ID of group. + Retrive information about a given group, specified by the `group_id` parameter. The group's full details, including `user_ids` and `application_ids` are returned in the response. + :param group_id: ID of the group. :return: :class:`Group ` Usage: @@ -823,9 +823,9 @@ def update_group( description: Optional[str] = None, ) -> Group: """ - Update a group - :param group_id: ID of group to update. - :param name: New name for the group (max length is 64 chars). MUST be unique inside an organization. + Update the parameters of group, including `name` and `description`. + :param group_id: ID of the group to update. + :param name: New name for the group (max length is 64 chars). MUST be unique inside an Organization. :param description: New description for the group (max length is 200 chars). :return: :class:`Group ` @@ -861,7 +861,7 @@ def set_group_members( application_ids: List[str], ) -> Group: """ - Overwrite users and applications of a group + Overwrite users and applications configuration in a group. Any information that you add using this command will overwrite the previous configuration. :param group_id: :param user_ids: :param application_ids: @@ -903,8 +903,8 @@ def add_group_member( application_id: Optional[str] = None, ) -> Group: """ - Add a user of an application to a group - :param group_id: ID of group. + Add a user or an application to a group. You can specify a `user_id` and and `application_id` in the body of your request. Note that you can only add one of each per request. + :param group_id: ID of the group. :param user_id: ID of the user to add. One-of ('member'): at most one of 'user_id', 'application_id' could be set. @@ -945,8 +945,8 @@ def remove_group_member( application_id: Optional[str] = None, ) -> Group: """ - Remove a user or an application from a group - :param group_id: ID of group. + Remove a user or an application from a group. You can specify a `user_id` and and `application_id` in the body of your request. Note that you can only remove one of each per request. Removing a user from a group means that any permissions given to them via the group (i.e. from an attached policy) will no longer apply. Be sure you want to remove these permissions from the user before proceeding. + :param group_id: ID of the group. :param user_id: ID of the user to remove. One-of ('member'): at most one of 'user_id', 'application_id' could be set. @@ -985,8 +985,8 @@ def delete_group( group_id: str, ) -> Optional[None]: """ - Delete a group - :param group_id: ID of group to delete. + Delete a group. Note that this action is irreversible and could delete permissions for group members. Policies attached to users and applications via this group will no longer apply. + :param group_id: ID of the group to delete. Usage: :: @@ -1019,17 +1019,17 @@ def list_policies( policy_name: Optional[str] = None, ) -> ListPoliciesResponse: """ - List policies of an organization + List the policies of an Organization. By default, the policies listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters to filter your query, such as `user_ids`, `groups_ids`, `application_ids`, and `policy_name`. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. - :param organization_id: ID of organization to filter. - :param editable: Filter out editable policies or not. - :param user_ids: Filter out by a list of user ID. - :param group_ids: Filter out by a list of group ID. - :param application_ids: Filter out by a list of application ID. - :param no_principal: True when the policy do not belong to any principal. - :param policy_name: Name of policy to fetch. + :param page: Page number. Value must be greater than 1. + :param organization_id: ID of the Organization to filter. + :param editable: Whether or not filter out editable policies. + :param user_ids: Whether or not to filter by list of user IDs. + :param group_ids: Whether or not to filter by list of group IDs. + :param application_ids: Filter by a list of application IDs. + :param no_principal: Whether or not the policy is attributed to a principal. + :param policy_name: Name of the policy to fetch. :return: :class:`ListPoliciesResponse ` Usage: @@ -1074,17 +1074,17 @@ def list_policies_all( policy_name: Optional[str] = None, ) -> List[Policy]: """ - List policies of an organization + List the policies of an Organization. By default, the policies listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters to filter your query, such as `user_ids`, `groups_ids`, `application_ids`, and `policy_name`. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. - :param organization_id: ID of organization to filter. - :param editable: Filter out editable policies or not. - :param user_ids: Filter out by a list of user ID. - :param group_ids: Filter out by a list of group ID. - :param application_ids: Filter out by a list of application ID. - :param no_principal: True when the policy do not belong to any principal. - :param policy_name: Name of policy to fetch. + :param page: Page number. Value must be greater than 1. + :param organization_id: ID of the Organization to filter. + :param editable: Whether or not filter out editable policies. + :param user_ids: Whether or not to filter by list of user IDs. + :param group_ids: Whether or not to filter by list of group IDs. + :param application_ids: Filter by a list of application IDs. + :param no_principal: Whether or not the policy is attributed to a principal. + :param policy_name: Name of the policy to fetch. :return: :class:`List[ListPoliciesResponse] ` Usage: @@ -1124,21 +1124,21 @@ def create_policy( no_principal: Optional[bool] = None, ) -> Policy: """ - Create a new policy - :param name: Name of policy to create (max length is 64 chars). - :param description: Description of policy to create (max length is 200 chars). - :param organization_id: ID of organization. + Create a new application. You must define the `name` parameter in the request. You can specify parameters such as `user_id`, `groups_id`, `application_id`, `no_principal`, `rules` and its child attributes. + :param name: Name of the policy to create (max length is 64 characters). + :param description: Description of the policy to create (max length is 200 characters). + :param organization_id: ID of the Organization. :param rules: Rules of the policy to create. - :param user_id: ID of user, owner of the policy. + :param user_id: ID of user attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. - :param group_id: ID of group, owner of the policy. + :param group_id: ID of group attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. - :param application_id: ID of application, owner of the policy. + :param application_id: ID of application attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. - :param no_principal: True when the policy do not belong to any principal. + :param no_principal: Whether or not a policy is attributed to a principal. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. :return: :class:`Policy ` @@ -1176,7 +1176,7 @@ def get_policy( policy_id: str, ) -> Policy: """ - Get an existing policy + Retrieve information about a policy, speficified by the `policy_id` parameter. The policy's full details, including `id`, `name`, `organization_id`, `nb_rules` and `nb_scopes`, `nb_permission_sets` are returned in the response. :param policy_id: Id of policy to search. :return: :class:`Policy ` @@ -1208,20 +1208,20 @@ def update_policy( no_principal: Optional[bool] = None, ) -> Policy: """ - Update an existing policy + Update the parameters of a policy, including `name`, `description`, `user_id`, `group_id`, `application_id` and `no_principal`. :param policy_id: Id of policy to update. - :param name: New name of policy (max length is 64 chars). - :param description: New description of policy (max length is 200 chars). - :param user_id: New ID of user, owner of the policy. + :param name: New name for the policy (max length is 64 characters). + :param description: New description of policy (max length is 200 characters). + :param user_id: New ID of user attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. - :param group_id: New ID of group, owner of the policy. + :param group_id: New ID of group attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. - :param application_id: New ID of application, owner of the policy. + :param application_id: New ID of application attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. - :param no_principal: True when the policy do not belong to any principal. + :param no_principal: Whether or not the policy is attributed to a principal. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. :return: :class:`Policy ` @@ -1260,7 +1260,7 @@ def delete_policy( policy_id: str, ) -> Optional[None]: """ - Delete a policy + Delete a policy. You must define specify the `policy_id` parameter in your request. Note that when deleting a policy, all permissions it gives to its principal (user, group or application) will be revoked. :param policy_id: Id of policy to delete. Usage: @@ -1309,7 +1309,7 @@ def set_rules( rules: List[RuleSpecs], ) -> SetRulesResponse: """ - Set rules of an existing policy + Overwrite the rules of a given policy. Any information that you add using this command will overwrite the previous configuration. If you include some of the rules you already had in your previous configuration in your new one, but you change their order, the new order of display will apply. While policy rules are ordered, they have no impact on the access logic of IAM because rules are allow-only. :param policy_id: Id of policy to update. :param rules: Rules of the policy to set. :return: :class:`SetRulesResponse ` @@ -1346,10 +1346,10 @@ def list_rules( page: Optional[int] = None, ) -> ListRulesResponse: """ - List rules of an existing policy + List the rules of a given policy. By default, the rules listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `policy_id` in the query path of your request. :param policy_id: Id of policy to search. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. + :param page: Page number. Value must be greater than 1. :return: :class:`ListRulesResponse ` Usage: @@ -1379,10 +1379,10 @@ def list_rules_all( page: Optional[int] = None, ) -> List[Rule]: """ - List rules of an existing policy + List the rules of a given policy. By default, the rules listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `policy_id` in the query path of your request. :param policy_id: Id of policy to search. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. + :param page: Page number. Value must be greater than 1. :return: :class:`List[ListRulesResponse] ` Usage: @@ -1411,11 +1411,11 @@ def list_permission_sets( organization_id: Optional[str] = None, ) -> ListPermissionSetsResponse: """ - List permission sets + List permission sets available for given Organization. You must define the `organization_id` in the query path of your request. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. - :param organization_id: Filter by organization ID. + :param page: Page number. Value must be greater than 1. + :param organization_id: Filter by Organization ID. :return: :class:`ListPermissionSetsResponse ` Usage: @@ -1448,11 +1448,11 @@ def list_permission_sets_all( organization_id: Optional[str] = None, ) -> List[PermissionSet]: """ - List permission sets + List permission sets available for given Organization. You must define the `organization_id` in the query path of your request. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. - :param organization_id: Filter by organization ID. + :param page: Page number. Value must be greater than 1. + :param organization_id: Filter by Organization ID. :return: :class:`List[ListPermissionSetsResponse] ` Usage: @@ -1490,23 +1490,23 @@ def list_api_keys( bearer_type: BearerType = BearerType.UNKNOWN_BEARER_TYPE, ) -> ListAPIKeysResponse: """ - List API keys + List API keys. By default, the API keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `editable`, `expired`, `access_key` and `bearer_id`. :param order_by: Criteria for sorting results. - :param page: Number of page. Value must be greater or equals to 1. + :param page: Page number. Value must be greater or equal to 1. :param page_size: Number of results per page. Value must be between 1 and 100. - :param organization_id: ID of organization. - :param application_id: ID of an application bearer. + :param organization_id: ID of Organization. + :param application_id: ID of application that bears the API key. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. - :param user_id: ID of a user bearer. + :param user_id: ID of user that bears the API key. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. - :param editable: Filter out editable API keys or not. - :param expired: Filter out expired API keys or not. - :param access_key: Filter out by access key. - :param description: Filter out by description. - :param bearer_id: Filter out by bearer ID. - :param bearer_type: Filter out by type of bearer. + :param editable: Whether to filter out editable API keys or not. + :param expired: Whether to filter out expired API keys or not. + :param access_key: Filter by access key. + :param description: Filter by description. + :param bearer_id: Filter by bearer ID. + :param bearer_type: Filter by type of bearer. :return: :class:`ListAPIKeysResponse ` Usage: @@ -1559,23 +1559,23 @@ def list_api_keys_all( bearer_type: Optional[BearerType] = None, ) -> List[APIKey]: """ - List API keys + List API keys. By default, the API keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `editable`, `expired`, `access_key` and `bearer_id`. :param order_by: Criteria for sorting results. - :param page: Number of page. Value must be greater or equals to 1. + :param page: Page number. Value must be greater or equal to 1. :param page_size: Number of results per page. Value must be between 1 and 100. - :param organization_id: ID of organization. - :param application_id: ID of an application bearer. + :param organization_id: ID of Organization. + :param application_id: ID of application that bears the API key. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. - :param user_id: ID of a user bearer. + :param user_id: ID of user that bears the API key. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. - :param editable: Filter out editable API keys or not. - :param expired: Filter out expired API keys or not. - :param access_key: Filter out by access key. - :param description: Filter out by description. - :param bearer_id: Filter out by bearer ID. - :param bearer_type: Filter out by type of bearer. + :param editable: Whether to filter out editable API keys or not. + :param expired: Whether to filter out expired API keys or not. + :param access_key: Filter by access key. + :param description: Filter by description. + :param bearer_id: Filter by bearer ID. + :param bearer_type: Filter by type of bearer. :return: :class:`List[ListAPIKeysResponse] ` Usage: @@ -1614,16 +1614,16 @@ def create_api_key( default_project_id: Optional[str] = None, ) -> APIKey: """ - Create an API key - :param application_id: ID of application principal. + Create an API key. You must specify the `application_id` or the `user_id` and the description. You can also specify the `default_project_id` which is the Project ID of your preferred Project, to use with Object Storage. The `access_key` and `secret_key` values are returned in the response. Note that he secret key is only showed once. Make sure that you copy and store both keys somewhere safe. + :param application_id: ID of the application. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. - :param user_id: ID of user principal. + :param user_id: ID of the user. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. :param expires_at: Expiration date of the API key. - :param default_project_id: The default project ID to use with object storage. - :param description: The description of the API key (max length is 200 chars). + :param default_project_id: The default Project ID to use with Object Storage. + :param description: The description of the API key (max length is 200 characters). :return: :class:`APIKey ` Usage: @@ -1656,7 +1656,7 @@ def get_api_key( access_key: str, ) -> APIKey: """ - Get an API key + Retrive information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation. :param access_key: Access key to search for. :return: :class:`APIKey ` @@ -1684,9 +1684,9 @@ def update_api_key( description: Optional[str] = None, ) -> APIKey: """ - Update an API key + Update the parameters of an API key, including `default_project_id` and `description`. :param access_key: Access key to update. - :param default_project_id: The new default project ID to set. + :param default_project_id: The new default Project ID to set. :param description: The new description to update. :return: :class:`APIKey ` @@ -1720,7 +1720,7 @@ def delete_api_key( access_key: str, ) -> Optional[None]: """ - Delete an API key + Delete an API key. Note that this action is irreversible and cannot be undone. Make sure you update any configurations using the API keys you delete. :param access_key: Access key to delete. Usage: @@ -1748,11 +1748,11 @@ def list_quota( organization_id: Optional[str] = None, ) -> ListQuotaResponse: """ - List all quota in the organization with the associated limit + List all product and features quota for an Organization, with their associated limits. By default, the quota listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. - :param organization_id: Filter by organization ID. + :param page: Page number. Value must be greater than 1. + :param organization_id: Filter by Organization ID. :return: :class:`ListQuotaResponse ` Usage: @@ -1785,11 +1785,11 @@ def list_quota_all( organization_id: Optional[str] = None, ) -> List[Quotum]: """ - List all quota in the organization with the associated limit + List all product and features quota for an Organization, with their associated limits. By default, the quota listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. :param order_by: Criteria for sorting results. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. - :param organization_id: Filter by organization ID. + :param page: Page number. Value must be greater than 1. + :param organization_id: Filter by Organization ID. :return: :class:`List[ListQuotaResponse] ` Usage: @@ -1817,9 +1817,9 @@ def get_quotum( organization_id: Optional[str] = None, ) -> Quotum: """ - Get a quotum in the organization with the associated limit - :param quotum_name: Name of the quotum to get. - :param organization_id: ID of the organization. + Retrieve information about a resource quota, speficified by the `quotum_name` parameter. The quota's `limit`, or whether it is unlimited, is returned in the response. + :param quotum_name: Name of the quota to get. + :param organization_id: ID of the Organization. :return: :class:`Quotum ` Usage: @@ -1856,7 +1856,7 @@ def list_jw_ts( :param order_by: Criteria for sorting results. :param audience_id: ID of the user to search. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. + :param page: Page number. Value must be greater to 1. :param expired: Filter out expired JWTs or not. :return: :class:`ListJWTsResponse ` @@ -1895,7 +1895,7 @@ def list_jw_ts_all( :param order_by: Criteria for sorting results. :param audience_id: ID of the user to search. :param page_size: Number of results per page. Value must be between 1 and 100. - :param page: Number of page. Value must be greater to 1. + :param page: Page number. Value must be greater to 1. :param expired: Filter out expired JWTs or not. :return: :class:`List[ListJWTsResponse] ` diff --git a/scaleway/scaleway/iam/v1alpha1/types.py b/scaleway/scaleway/iam/v1alpha1/types.py index 73d34126e..306e4d011 100644 --- a/scaleway/scaleway/iam/v1alpha1/types.py +++ b/scaleway/scaleway/iam/v1alpha1/types.py @@ -155,24 +155,24 @@ class APIKey: access_key: str """ - Access key of API key. + Access key of the API key. """ secret_key: Optional[str] """ - Secret key of API Key. + Secret key of the API Key. """ application_id: Optional[str] """ - ID of application bearer. + ID of application that bears the API key. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. """ user_id: Optional[str] """ - ID of user bearer. + ID of user that bears the API key. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. """ @@ -184,22 +184,22 @@ class APIKey: created_at: Optional[datetime] """ - Creation date and time of API key. + Date and time of API key creation. """ updated_at: Optional[datetime] """ - Last update date and time of API key. + Date and time of last API key update. """ expires_at: Optional[datetime] """ - Expiration date and time of API key. + Date and time of API key expiration. """ default_project_id: str """ - The default project ID specified for this API key. + The default Project ID specified for this API key. """ editable: bool @@ -209,7 +209,7 @@ class APIKey: creation_ip: str """ - IP Address of the device which created the API key. + IP address of the device that created the API key. """ @@ -221,12 +221,12 @@ class Application: id: str """ - ID of application. + ID of the application. """ name: str """ - Name of application. + Name of the application. """ description: str @@ -236,17 +236,17 @@ class Application: created_at: Optional[datetime] """ - Creation date of application. + Date and time application was created. """ updated_at: Optional[datetime] """ - Last update date of application. + Date and time of last application update. """ organization_id: str """ - ID of organization. + ID of the Organization. """ editable: bool @@ -256,7 +256,7 @@ class Application: nb_api_keys: int """ - Number of API keys owned by the application. + Number of API keys attributed to the application. """ @@ -268,27 +268,27 @@ class Group: id: str """ - ID of group. + ID of the group. """ created_at: Optional[datetime] """ - Creation date and time of group. + Date and time of group creation. """ updated_at: Optional[datetime] """ - Last update date and time of group. + Date and time of last group update. """ organization_id: str """ - ID of organization linked to the group. + ID of Organization linked to the group. """ name: str """ - Name of group. + Name of the group. """ description: str @@ -522,27 +522,27 @@ class PermissionSet: id: str """ - Id of permission set. + Id of the permission set. """ name: str """ - Name of permission set. + Name of the permission set. """ scope_type: PermissionSetScopeType """ - Scope of permission set. + Scope of the permission set. """ description: str """ - Description of permission set. + Description of the permission set. """ categories: Optional[List[str]] """ - Categories of permission set. + Categories of the permission set. """ @@ -554,78 +554,78 @@ class Policy: id: str """ - Id of policy. + Id of the policy. """ name: str """ - Name of policy. + Name of the policy. """ description: str """ - Description of policy. + Description of the policy. """ organization_id: str """ - Organization ID of policy. + Organization ID of the policy. """ created_at: Optional[datetime] """ - Creation date and time of policy. + Date and time of policy creation. """ updated_at: Optional[datetime] """ - Last update date and time of policy. + Date and time of last policy update. """ editable: bool """ - Editable status of policy. + Whether or not a policy is editable. """ nb_rules: int """ - Number of rules of policy. + Number of rules of the policy. """ nb_scopes: int """ - Number of scopes of policy. + Number of policy scopes. """ nb_permission_sets: int """ - Number of permission sets of policy. + Number of permission sets of the policy. """ user_id: Optional[str] """ - ID of user, owner of the policy. + ID of the user attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ group_id: Optional[str] """ - ID of group, owner of the policy. + ID of the group attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ application_id: Optional[str] """ - ID of application, owner of the policy. + ID of the application attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ no_principal: Optional[bool] """ - True when the policy do not belong to any principal. + Whether or not a policy is attributed to a principal. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ @@ -639,19 +639,19 @@ class Quotum: name: str """ - Name of the quotum. + Name of the quota. """ limit: Optional[int] """ - Max limit of the quotum. + Maximum limit of the quota. One-of ('value'): at most one of 'limit', 'unlimited' could be set. """ unlimited: Optional[bool] """ - Whether the quotum is unlimited or not. + Whether or not the quota is unlimited. One-of ('value'): at most one of 'limit', 'unlimited' could be set. """ @@ -680,21 +680,21 @@ class Rule: project_ids: Optional[List[str]] """ - List of project IDs scoped to the rule. + List of Project IDs the rule is scoped to. One-of ('scope'): at most one of 'project_ids', 'organization_id', 'account_root_user_id' could be set. """ organization_id: Optional[str] """ - ID of organization scoped to the rule. + ID of Organization the rule is scoped to. One-of ('scope'): at most one of 'project_ids', 'organization_id', 'account_root_user_id' could be set. """ account_root_user_id: Optional[str] """ - ID of account root user scoped to the rule. + ID of account root user the rule is scoped to. One-of ('scope'): at most one of 'project_ids', 'organization_id', 'account_root_user_id' could be set. """ @@ -713,14 +713,14 @@ class RuleSpecs: project_ids: Optional[List[str]] """ - List of project IDs scoped to the rule. + List of Project IDs the rule is scoped to. One-of ('scope'): at most one of 'project_ids', 'organization_id' could be set. """ organization_id: Optional[str] """ - ID of organization scoped to the rule. + ID of Organization the rule is scoped to. One-of ('scope'): at most one of 'project_ids', 'organization_id' could be set. """ @@ -749,7 +749,7 @@ class SSHKey: fingerprint: str """ - Fingerprint of SSH key. + Fingerprint of the SSH key. """ created_at: Optional[datetime] @@ -764,12 +764,12 @@ class SSHKey: organization_id: str """ - ID of organization linked to the SSH key. + ID of Organization linked to the SSH key. """ project_id: str """ - ID of project linked to the SSH key. + ID of Project linked to the SSH key. """ disabled: bool @@ -786,7 +786,7 @@ class SetRulesResponse: rules: List[Rule] """ - Rules of policy. + Rules of the policy. """ @@ -808,42 +808,42 @@ class User: created_at: Optional[datetime] """ - Creation date of user. + Date user was created. """ updated_at: Optional[datetime] """ - Last update date of user. + Date of last user update. """ organization_id: str """ - ID of organization. + ID of the Organization. """ deletable: bool """ - Deletion status of user. Owner user cannot be deleted. + Deletion status of user. Owners cannot be deleted. """ last_login_at: Optional[datetime] """ - Last login date. + Date of the last login. """ type_: UserType """ - Type of the user. + Type of user. """ two_factor_enabled: bool """ - 2FA enabled. + Whether MFA is enabled. """ status: UserStatus """ - Status of invitation for the user. + Status of user invitation. """ @@ -851,12 +851,12 @@ class User: class ListSSHKeysRequest: order_by: Optional[ListSSHKeysRequestOrderBy] """ - Sort order of SSH keys. + Sort order of the SSH keys. """ page: Optional[int] """ - Requested page number. Value must be greater or equals to 1. + Requested page number. Value must be greater or equal to 1. """ page_size: Optional[int] @@ -866,7 +866,7 @@ class ListSSHKeysRequest: organization_id: Optional[str] """ - Filter by organization ID. + Filter by Organization ID. """ name: Optional[str] @@ -876,12 +876,12 @@ class ListSSHKeysRequest: project_id: Optional[str] """ - Filter by project ID. + Filter by Project ID. """ disabled: Optional[bool] """ - Filter out disabled SSH keys or not. + Whether to include disabled SSH keys or not. """ @@ -894,12 +894,12 @@ class CreateSSHKeyRequest: public_key: str """ - SSH public key. Currently ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported. Max length is 65000. + SSH public key. Currently only the ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported. Max length is 65000. """ project_id: Optional[str] """ - Project owning the resource. + Project the resource is attributed to. """ @@ -945,17 +945,17 @@ class ListUsersRequest: page: Optional[int] """ - Number of page. Value must be greater or equals to 1. + Page number. Value must be greater or equal to 1. """ organization_id: Optional[str] """ - ID of organization to filter. + ID of the Organization to filter. """ user_ids: Optional[List[str]] """ - Filter out by a list of ID. + Filter by list of IDs. """ @@ -963,7 +963,7 @@ class ListUsersRequest: class GetUserRequest: user_id: str """ - ID of user to find. + ID of the user to find. """ @@ -971,7 +971,7 @@ class GetUserRequest: class DeleteUserRequest: user_id: str """ - ID of user to delete. + ID of the user to delete. """ @@ -989,27 +989,27 @@ class ListApplicationsRequest: page: Optional[int] """ - Number of page. Value must be greater to 1. + Page number. Value must be greater than 1. """ name: Optional[str] """ - Name of application to filter. + Name of the application to filter. """ organization_id: Optional[str] """ - ID of organization to filter. + ID of the Organization to filter. """ editable: Optional[bool] """ - Filter out editable applications or not. + Whether to filter out editable applications or not. """ application_ids: Optional[List[str]] """ - Filter out by a list of ID. + Filter by list of IDs. """ @@ -1017,17 +1017,17 @@ class ListApplicationsRequest: class CreateApplicationRequest: name: Optional[str] """ - Name of application to create (max length is 64 chars). + Name of the application to create (max length is 64 characters). """ organization_id: Optional[str] """ - ID of organization. + ID of the Organization. """ description: str """ - Description of application (max length is 200 chars). + Description of the application (max length is 200 characters). """ @@ -1035,7 +1035,7 @@ class CreateApplicationRequest: class GetApplicationRequest: application_id: str """ - ID of application to find. + ID of the application to find. """ @@ -1043,17 +1043,17 @@ class GetApplicationRequest: class UpdateApplicationRequest: application_id: str """ - ID of application to update. + ID of the application to update. """ name: Optional[str] """ - New name of application (max length is 64 chars). + New name for the application (max length is 64 chars). """ description: Optional[str] """ - New description of application (max length is 200 chars). + New description for the application (max length is 200 chars). """ @@ -1061,7 +1061,7 @@ class UpdateApplicationRequest: class DeleteApplicationRequest: application_id: str """ - ID of application to delete. + ID of the application to delete. """ @@ -1074,7 +1074,7 @@ class ListGroupsRequest: page: Optional[int] """ - Requested page number. Value must be greater or equals to 1. + Requested page number. Value must be greater or equal to 1. """ page_size: Optional[int] @@ -1084,7 +1084,7 @@ class ListGroupsRequest: organization_id: Optional[str] """ - Filter by organization ID. + Filter by Organization ID. """ name: Optional[str] @@ -1094,17 +1094,17 @@ class ListGroupsRequest: application_ids: Optional[List[str]] """ - Filter out by a list of application ID. + Filter by a list of application IDs. """ user_ids: Optional[List[str]] """ - Filter out by a list of user ID. + Filter by a list of user IDs. """ group_ids: Optional[List[str]] """ - Filter out by a list of group ID. + Filter by a list of group IDs. """ @@ -1112,12 +1112,12 @@ class ListGroupsRequest: class CreateGroupRequest: organization_id: Optional[str] """ - ID of organization linked to the group. + ID of Organization linked to the group. """ name: Optional[str] """ - Name of the group to create (max length is 64 chars). MUST be unique inside an organization. + Name of the group to create (max length is 64 chars). MUST be unique inside an Organization. """ description: str @@ -1130,7 +1130,7 @@ class CreateGroupRequest: class GetGroupRequest: group_id: str """ - ID of group. + ID of the group. """ @@ -1138,12 +1138,12 @@ class GetGroupRequest: class UpdateGroupRequest: group_id: str """ - ID of group to update. + ID of the group to update. """ name: Optional[str] """ - New name for the group (max length is 64 chars). MUST be unique inside an organization. + New name for the group (max length is 64 chars). MUST be unique inside an Organization. """ description: Optional[str] @@ -1165,7 +1165,7 @@ class SetGroupMembersRequest: class AddGroupMemberRequest: group_id: str """ - ID of group. + ID of the group. """ user_id: Optional[str] @@ -1187,7 +1187,7 @@ class AddGroupMemberRequest: class RemoveGroupMemberRequest: group_id: str """ - ID of group. + ID of the group. """ user_id: Optional[str] @@ -1209,7 +1209,7 @@ class RemoveGroupMemberRequest: class DeleteGroupRequest: group_id: str """ - ID of group to delete. + ID of the group to delete. """ @@ -1227,42 +1227,42 @@ class ListPoliciesRequest: page: Optional[int] """ - Number of page. Value must be greater to 1. + Page number. Value must be greater than 1. """ organization_id: Optional[str] """ - ID of organization to filter. + ID of the Organization to filter. """ editable: Optional[bool] """ - Filter out editable policies or not. + Whether or not filter out editable policies. """ user_ids: Optional[List[str]] """ - Filter out by a list of user ID. + Whether or not to filter by list of user IDs. """ group_ids: Optional[List[str]] """ - Filter out by a list of group ID. + Whether or not to filter by list of group IDs. """ application_ids: Optional[List[str]] """ - Filter out by a list of application ID. + Filter by a list of application IDs. """ no_principal: Optional[bool] """ - True when the policy do not belong to any principal. + Whether or not the policy is attributed to a principal. """ policy_name: Optional[str] """ - Name of policy to fetch. + Name of the policy to fetch. """ @@ -1270,17 +1270,17 @@ class ListPoliciesRequest: class CreatePolicyRequest: name: Optional[str] """ - Name of policy to create (max length is 64 chars). + Name of the policy to create (max length is 64 characters). """ description: str """ - Description of policy to create (max length is 200 chars). + Description of the policy to create (max length is 200 characters). """ organization_id: Optional[str] """ - ID of organization. + ID of the Organization. """ rules: Optional[List[RuleSpecs]] @@ -1290,28 +1290,28 @@ class CreatePolicyRequest: user_id: Optional[str] """ - ID of user, owner of the policy. + ID of user attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ group_id: Optional[str] """ - ID of group, owner of the policy. + ID of group attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ application_id: Optional[str] """ - ID of application, owner of the policy. + ID of application attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ no_principal: Optional[bool] """ - True when the policy do not belong to any principal. + Whether or not a policy is attributed to a principal. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ @@ -1334,38 +1334,38 @@ class UpdatePolicyRequest: name: Optional[str] """ - New name of policy (max length is 64 chars). + New name for the policy (max length is 64 characters). """ description: Optional[str] """ - New description of policy (max length is 200 chars). + New description of policy (max length is 200 characters). """ user_id: Optional[str] """ - New ID of user, owner of the policy. + New ID of user attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ group_id: Optional[str] """ - New ID of group, owner of the policy. + New ID of group attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ application_id: Optional[str] """ - New ID of application, owner of the policy. + New ID of application attributed to the policy. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ no_principal: Optional[bool] """ - True when the policy do not belong to any principal. + Whether or not the policy is attributed to a principal. One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set. """ @@ -1411,7 +1411,7 @@ class ListRulesRequest: page: Optional[int] """ - Number of page. Value must be greater to 1. + Page number. Value must be greater than 1. """ @@ -1429,12 +1429,12 @@ class ListPermissionSetsRequest: page: Optional[int] """ - Number of page. Value must be greater to 1. + Page number. Value must be greater than 1. """ organization_id: Optional[str] """ - Filter by organization ID. + Filter by Organization ID. """ @@ -1447,7 +1447,7 @@ class ListAPIKeysRequest: page: Optional[int] """ - Number of page. Value must be greater or equals to 1. + Page number. Value must be greater or equal to 1. """ page_size: Optional[int] @@ -1457,12 +1457,12 @@ class ListAPIKeysRequest: organization_id: Optional[str] """ - ID of organization. + ID of Organization. """ application_id: Optional[str] """ - ID of an application bearer. + ID of application that bears the API key. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. :deprecated @@ -1470,7 +1470,7 @@ class ListAPIKeysRequest: user_id: Optional[str] """ - ID of a user bearer. + ID of user that bears the API key. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. :deprecated @@ -1478,32 +1478,32 @@ class ListAPIKeysRequest: editable: Optional[bool] """ - Filter out editable API keys or not. + Whether to filter out editable API keys or not. """ expired: Optional[bool] """ - Filter out expired API keys or not. + Whether to filter out expired API keys or not. """ access_key: Optional[str] """ - Filter out by access key. + Filter by access key. """ description: Optional[str] """ - Filter out by description. + Filter by description. """ bearer_id: Optional[str] """ - Filter out by bearer ID. + Filter by bearer ID. """ bearer_type: Optional[BearerType] """ - Filter out by type of bearer. + Filter by type of bearer. """ @@ -1511,14 +1511,14 @@ class ListAPIKeysRequest: class CreateAPIKeyRequest: application_id: Optional[str] """ - ID of application principal. + ID of the application. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. """ user_id: Optional[str] """ - ID of user principal. + ID of the user. One-of ('bearer'): at most one of 'application_id', 'user_id' could be set. """ @@ -1530,12 +1530,12 @@ class CreateAPIKeyRequest: default_project_id: Optional[str] """ - The default project ID to use with object storage. + The default Project ID to use with Object Storage. """ description: str """ - The description of the API key (max length is 200 chars). + The description of the API key (max length is 200 characters). """ @@ -1556,7 +1556,7 @@ class UpdateAPIKeyRequest: default_project_id: Optional[str] """ - The new default project ID to set. + The new default Project ID to set. """ description: Optional[str] @@ -1587,12 +1587,12 @@ class ListQuotaRequest: page: Optional[int] """ - Number of page. Value must be greater to 1. + Page number. Value must be greater than 1. """ organization_id: Optional[str] """ - Filter by organization ID. + Filter by Organization ID. """ @@ -1600,12 +1600,12 @@ class ListQuotaRequest: class GetQuotumRequest: quotum_name: str """ - Name of the quotum to get. + Name of the quota to get. """ organization_id: Optional[str] """ - ID of the organization. + ID of the Organization. """ @@ -1628,7 +1628,7 @@ class ListJWTsRequest: page: Optional[int] """ - Number of page. Value must be greater to 1. + Page number. Value must be greater to 1. """ expired: Optional[bool]