Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions scaleway-async/scaleway_async/iam/v1alpha1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -483,7 +483,7 @@ async def update_user(
Update the parameters of a user, including `tags`.
:param user_id: ID of the user to update.
:param tags: New tags for the user (maximum of 10 tags).
:param email: New email for the user (only available on Members).
:param email: IAM member email.
:return: :class:`User <User>`

Usage:
Expand Down Expand Up @@ -554,7 +554,7 @@ async def create_user(
:param email: Email of the user.
One-Of ('type'): at most one of 'email', 'member' could be set.
:param tags: Tags associated with the user.
:param member: A new IAM Member to create.
:param member: Details of IAM member. Private Beta feature.
One-Of ('type'): at most one of 'email', 'member' could be set.
:return: :class:`User <User>`

Expand Down Expand Up @@ -589,7 +589,7 @@ async def update_user_password(
send_email: bool,
) -> User:
"""
Update an user's password.
Update an user's password. Private Beta feature.
:param user_id: ID of the user to update.
:param password: The new password.
:param send_email: Whether or not to send an email alerting the user their password has changed.
Expand Down Expand Up @@ -629,8 +629,8 @@ async def lock_user(
user_id: str,
) -> User:
"""
Lock a user.
Lock a user. Note that a locked user cannot log in or use API keys until the locked status is removed.
Lock a member.
Lock a member. A locked member cannot log in or use API keys until the locked status is removed. Private Beta feature.
:param user_id: ID of the user to lock.
:return: :class:`User <User>`

Expand Down Expand Up @@ -659,7 +659,8 @@ async def unlock_user(
user_id: str,
) -> User:
"""
Unlock a user.
Unlock a member.
Unlock a member. Private Beta feature.
:param user_id: ID of the user to unlock.
:return: :class:`User <User>`

Expand Down Expand Up @@ -688,8 +689,8 @@ async def list_grace_periods(
user_id: Optional[str] = None,
) -> ListGracePeriodsResponse:
"""
List grace periods of a user.
List the grace periods of a user.
List grace periods of a member.
List the grace periods of a member. Private Beta feature.
:param user_id: ID of the user to list grace periods for.
:return: :class:`ListGracePeriodsResponse <ListGracePeriodsResponse>`

Expand Down Expand Up @@ -2018,7 +2019,7 @@ async def create_api_key(
) -> APIKey:
"""
Create an API key.
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.
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 the secret key is only shown once. Make sure that you copy and store both keys somewhere safe.
:param description: Description of the API key (max length is 200 characters).
:param application_id: ID of the application.
One-Of ('bearer'): at most one of 'application_id', 'user_id' could be set.
Expand Down
2 changes: 1 addition & 1 deletion scaleway-async/scaleway_async/iam/v1alpha1/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -1939,5 +1939,5 @@ class UpdateUserRequest:

email: Optional[str]
"""
New email for the user (only available on Members).
IAM member email.
"""
19 changes: 10 additions & 9 deletions scaleway/scaleway/iam/v1alpha1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -483,7 +483,7 @@ def update_user(
Update the parameters of a user, including `tags`.
:param user_id: ID of the user to update.
:param tags: New tags for the user (maximum of 10 tags).
:param email: New email for the user (only available on Members).
:param email: IAM member email.
:return: :class:`User <User>`

Usage:
Expand Down Expand Up @@ -554,7 +554,7 @@ def create_user(
:param email: Email of the user.
One-Of ('type'): at most one of 'email', 'member' could be set.
:param tags: Tags associated with the user.
:param member: A new IAM Member to create.
:param member: Details of IAM member. Private Beta feature.
One-Of ('type'): at most one of 'email', 'member' could be set.
:return: :class:`User <User>`

Expand Down Expand Up @@ -589,7 +589,7 @@ def update_user_password(
send_email: bool,
) -> User:
"""
Update an user's password.
Update an user's password. Private Beta feature.
:param user_id: ID of the user to update.
:param password: The new password.
:param send_email: Whether or not to send an email alerting the user their password has changed.
Expand Down Expand Up @@ -629,8 +629,8 @@ def lock_user(
user_id: str,
) -> User:
"""
Lock a user.
Lock a user. Note that a locked user cannot log in or use API keys until the locked status is removed.
Lock a member.
Lock a member. A locked member cannot log in or use API keys until the locked status is removed. Private Beta feature.
:param user_id: ID of the user to lock.
:return: :class:`User <User>`

Expand Down Expand Up @@ -659,7 +659,8 @@ def unlock_user(
user_id: str,
) -> User:
"""
Unlock a user.
Unlock a member.
Unlock a member. Private Beta feature.
:param user_id: ID of the user to unlock.
:return: :class:`User <User>`

Expand Down Expand Up @@ -688,8 +689,8 @@ def list_grace_periods(
user_id: Optional[str] = None,
) -> ListGracePeriodsResponse:
"""
List grace periods of a user.
List the grace periods of a user.
List grace periods of a member.
List the grace periods of a member. Private Beta feature.
:param user_id: ID of the user to list grace periods for.
:return: :class:`ListGracePeriodsResponse <ListGracePeriodsResponse>`

Expand Down Expand Up @@ -2018,7 +2019,7 @@ def create_api_key(
) -> APIKey:
"""
Create an API key.
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.
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 the secret key is only shown once. Make sure that you copy and store both keys somewhere safe.
:param description: Description of the API key (max length is 200 characters).
:param application_id: ID of the application.
One-Of ('bearer'): at most one of 'application_id', 'user_id' could be set.
Expand Down
2 changes: 1 addition & 1 deletion scaleway/scaleway/iam/v1alpha1/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -1939,5 +1939,5 @@ class UpdateUserRequest:

email: Optional[str]
"""
New email for the user (only available on Members).
IAM member email.
"""
Loading