i V S r SSKJrJr SSKrSSKJrJrJr SSK J
r
SSK J r SSK
Jr SS KJr " S
S \5 r " S S
5 r " S S5 r " S S5 r " S S5 r " S S5 r " S S5 r " S S5 r " S S5 r " S S 5 r " S S 5 r " S S!5 r g)"zR
Manage the lifecycle of your users using User Management APIs.
API Version: 1.0
)DictListN) BaseServiceDetailedResponseget_query_param)
Authenticator)"get_authenticator_from_environment)
convert_model )get_sdk_headersc \ rS rSrSrSrSr\\4S\SS 4S jj5 r S3S \
SS4S
jjr SSSSSS .S \S
\ S\
S\S\S\S\4S jjrSSSS.S \S\S S\S S\\ S\4
S jjrSS.S \S\S \S\4S jjrSSSSSSSSS .S \S\S \S \S!\S"\S#\S$\S%\S \S\4S& jjrSS.S \S\S \S\4S' jjrSS(.S \S\4S) jjrS \S\S\4S* jrS \S\S\4S+ jrSSSSS,.S \S\S-\S.\S/\S0\
S\4S1 jjrS2rg)4UserManagementV1( z The User Management V1 service.z%https://user-management.cloud.ibm.comuser_management service_namereturnc N [ U5 nU " U5 nUR U5 U$ )zw
Return a new client for the User Management service using the specified
parameters and external configuration.
)r configure_service)clsr
authenticatorservices b/home/james-whalen/.local/lib/python3.13/site-packages/ibm_platform_services/user_management_v1.py new_instance UserManagementV1.new_instance. s+ ;<H
m$!!,/ Nr c B [ R " X R US9 g)a6
Construct a new client for the User Management service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-sdk-core/blob/main/README.md
about initializing the authenticator of your choice.
) service_urlr N)r __init__DEFAULT_SERVICE_URL)selfr s r r UserManagementV1.__init__< s T/G/GWder )limitinclude_settingssearchstartuser_id
account_idr" r# r$ r% r& c U( d [ S5 e0 n[ U R SSS9n UR U 5 UUUUUS.n
SU; a# UR UR S5 5 US SUS' S /n U R U5 n [
[ X5 5 n
S
R " S
0 U
D6nU R S UUU
S 9nU R " U40 UD6nU$ )a
List users.
Retrieve users in the account. You can use the IAM service token or a user token
for authorization. To use this method, the requesting user or service ID must have
at least the viewer, editor, or administrator role on the User Management service.
If unrestricted view is enabled, the user can see all users in the same account
without an IAM role. If restricted view is enabled and user has the viewer,
editor, or administrator role on the user management service, the API returns all
users in the account. If unrestricted view is enabled and the user does not have
these roles, the API returns only the current user. Users are returned in a
paginated list with a default limit of 100 users. You can iterate through all
users by following the `next_url` field. Additional substring search fields are
supported to filter the users.
:param str account_id: The account ID of the specified user.
:param int limit: (optional) The number of results to be returned.
:param bool include_settings: (optional) The user settings to be returned.
Set to true to view language, allowed IP address, and authentication
settings.
:param str search: (optional) The desired search results to be returned. To
view the list of users with the additional search filter, use the following
query options: `firstname`, `lastname`, `email`, `state`, `substate`,
`iam_id`, `realm`, and `userId`. HTML URL encoding for the search query and
`:` must be used. For example, search=state%3AINVALID returns a list of
invalid users. Multiple search queries can be combined to obtain `OR`
results using `,` operator (not URL encoded). For example,
search=state%3AINVALID,email%3Amail.test.ibm.com.
:param str start: (optional) An optional token that indicates the beginning
of the page of results to be returned. If omitted, the first page of
results is returned. This value is obtained from the 'next_url' field of
the operation response.
:param str user_id: (optional) Filter users based on their user ID.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse with `dict` result representing a `UserList` object
account_id must be providedV1
list_usersr service_version operation_id)r" r# r$ _startr& headersapplication/jsonAcceptr' /v2/accounts/{account_id}/usersGETmethodurlr0 params
ValueErrorr DEFAULT_SERVICE_NAMEupdategetencode_path_varsdictzipformatprepare_requestsend)r r' r" r# r$ r% r& kwargsr0 sdk_headersr8 path_param_keyspath_param_valuespath_param_dictr7 requestresponses r r+ UserManagementV1.list_usersM s b :; ;% 22 %
{# 0
NN6::i0 1y! .'. 1 1* = s? FG/66I I&& '
99W//r users
iam_policy
access_groupsrN
InviteUserrO InviteUserIamPolicyrP c U( d [ S5 eUb U Vs/ s H n[ U5 PM nnUb U Vs/ s H n[ U5 PM nn0 n[ U R SSS9nUR U5 UUUS.n U R 5 V
V s0 s H u pU c M
X_M n n
n [ R " U 5 n SUS' SU; a# UR UR S5 5 US SUS ' S
/n U R U5 n
[ [ X5 5 nS R " S0 UD6nU R S UUU S
9nU R " U40 UD6nU$ s snf s snf s sn n
f )a
Invite users to an account.
Invite users to the account. You must use a user token for authorization. Service
IDs can't invite users to the account. To use this method, the requesting user
must have the editor or administrator role on the User Management service. For
more information, see the [Inviting
users](https://cloud.ibm.com/docs/account?topic=account-iamuserinv) documentation.
You can specify the user account role and the corresponding IAM policy information
in the request body.
When you invite a user to an account, the user is
initially created in the `PROCESSING` state. After the user is successfully
created, all specified permissions are configured, and the activation email is
sent, the invited user is transitioned to the `PENDING` state. When the invited
user clicks the activation email and creates and confirms their IBM Cloud account,
the user is transitioned to `ACTIVE` state. If the user email is already verified,
no email is generated.
:param str account_id: The account ID of the specified user.
:param List[InviteUser] users: (optional) A list of users to be invited.
:param List[InviteUserIamPolicy] iam_policy: (optional) A list of IAM
policies.
:param List[str] access_groups: (optional) A list of access groups.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse with `dict` result representing a `InvitedUserList` object
r) r* invite_usersr, rM r1 content-typer0 r2 r' r3 POSTr6 r7 r0 datar9 )r; r
r r< r= itemsjsondumpsr> r? r@ rA rB rC rD )r r' rN rO rP rE xr0 rF rX kvrG rH rI r7 rJ rK s r rT UserManagementV1.invite_users s H :; ; /45u!]1%uE5 !4>?Jq-*JJ?% 22 '
{# $ *
$(::<A<!1<Azz$ "4 NN6::i0 1y! .'. 1 1* = s? FG/66I I&& '
99W//K 6? Bs EE E E)include_activityiam_idr` c U( d [ S5 eU( d [ S5 e0 n[ U R SSS9nUR U5 SU0nSU; a# UR UR S5 5 US SUS ' S
S /nU R X5 n [
[ X5 5 n
S R " S0 U
D6n U R S
U UUS9n U R " U 40 UD6n
U
$ )a
Get user profile.
Retrieve a user's profile by the user's IAM ID in your account. You can use the
IAM service token or a user token for authorization. To use this method, the
requesting user or service ID must have at least the viewer, editor, or
administrator role on the User Management service.
:param str account_id: The account ID of the specified user.
:param str iam_id: The user's IAM ID.
:param str include_activity: (optional) Include activity information of the
user, such as the last authentication timestamp.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse with `dict` result representing a `UserProfile` object
r) iam_id must be providedr* get_user_profiler, r` r0 r1 r2 r' ra (/v2/accounts/{account_id}/users/{iam_id}r4 r5 r9 r: r r' ra r` rE r0 rF r8 rG rH rI r7 rJ rK s r rd !UserManagementV1.get_user_profile s 2 :; ; 67 7% 22 +
{#
0
NN6::i0 1y! .'2 1 1* E s? FG8??R/R&& '
99W//r ) firstnamelastnamestateemail phonenumberaltphonenumberphotor` rh ri rj rk rl rm rn c h U( d [ S5 eU( d [ S5 e0 n [ U R SSS9n
U R U
5 SU
0nUUUUUUU S.nUR 5 VVs0 s H u nnUc M UU_M nnn[
R " U5 nSU S ' S
U ; a# U R U R S
5 5 U S
S S /nU R X5 n[ [ UU5 5 nS
R " S0 UD6nU R SUU UUS9nU R " U40 U D6nU$ s snnf )aB
Partially update user profile.
Partially update a user's profile by user's IAM ID. You can use the IAM service
token or a user token for authorization. To use this method, the requesting user
or service ID must have at least the editor or administrator role on the User
Management service. A user or service ID with these roles can change a user's
state between `ACTIVE`, `VPN_ONLY`, or `DISABLED_CLASSIC_INFRASTRUCTURE`, but they
can't change the state to `PROCESSING` or `PENDING` because these are system
states. For other request body fields, a user can update their own profile without
having User Management service permissions.
:param str account_id: The account ID of the specified user.
:param str iam_id: The user's IAM ID.
:param str firstname: (optional) The first name of the user.
:param str lastname: (optional) The last name of the user.
:param str state: (optional) The state of the user. Possible values are
`PROCESSING`, `PENDING`, `ACTIVE`, `DISABLED_CLASSIC_INFRASTRUCTURE`, and
`VPN_ONLY`.
:param str email: (optional) The email address of the user.
:param str phonenumber: (optional) The phone number of the user.
:param str altphonenumber: (optional) The alternative phone number of the
user.
:param str photo: (optional) A link to a photo of the user.
:param str include_activity: (optional) Include activity information of the
user, such as the last authentication timestamp.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
r) rc r* update_user_profiler, r` )rh ri rj rk rl rm rn r1 rU r0 r' ra re PATCH)r6 r7 r0 r8 rX r9 r; r r< r= rY rZ r[ r> r? r@ rA rB rC rD )r r' ra rh ri rj rk rl rm rn r` rE r0 rF r8 rX r] r^ rG rH rI r7 rJ rK s r rp $UserManagementV1.update_user_profile- se \ :; ; 67 7% 22 .
{#
0
# & ,
$(::<A<!Q11<Azz$ "4 NN6::i0 1y!'2 1 1* E s?4E FG8??R/R&& '
99W//+ Bs .
D.<D.c U( d [ S5 eU( d [ S5 e0 n[ U R SSS9nUR U5 SU0nSU; a# UR UR S5 5 US SS /nU R X5 n [
[ X5 5 n
S
R " S
0 U
D6n U R S U UUS 9n U R " U 40 UD6n
U
$ )a#
Remove user from account.
Remove users from an account by user's IAM ID. You must use a user token for
authorization. Service IDs can't remove users from an account. To use this method,
the requesting user must have the editor or administrator role on the User
Management service. For more information, see the [Removing
users](https://cloud.ibm.com/docs/account?topic=account-remove) documentation.
:param str account_id: The account ID of the specified user.
:param str iam_id: The user's IAM ID.
:param str include_activity: (optional) Include activity information of the
user, such as the last authentication timestamp.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
r) rc r* remove_userr, r` r0 r' ra re DELETEr5 r9 r: rf s r ru UserManagementV1.remove_user s 4 :; ; 67 7% 22 &
{#
0
NN6::i0 1y!'2 1 1* E s? FG8??R/R&& '
99W//r )r' c 0 n[ U R SSS9nUR U5 SU0nUR 5 VVs0 s H u pgUc M
Xg_M nnn[ R
" U5 nSUS' SU; a# UR UR
S5 5 US SnU R S UUUS
9n U R " U 40 UD6n
U
$ s snnf ) a&
Accept an invitation.
Accept a user invitation to an account. You can use the user's token for
authorization. To use this method, the requesting user must provide the account ID
for the account that they are accepting an invitation for. If the user already
accepted the invitation request, it returns 204 with no response body.
:param str account_id: (optional) The account ID.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
r* acceptr, r' r1 rU r0 z/v2/users/acceptrV rW ) r r< r= rY rZ r[ r> rC rD ) r r' rE r0 rF rX r] r^ r7 rJ rK s r ry UserManagementV1.accept s ( % 22 !
{#
*
$(::<A<!1<Azz$ "4 NN6::i0 1y! && '
99W//# Bs C
Cc U( d [ S5 eU( d [ S5 e0 n[ U R SSS9nUR U5 SU; a# UR UR S5 5 US SS/nU R X5 n[
[ Xg5 5 nS R " S 0 UD6n U R S
U US 9n
U R " U
40 UD6n U $ )
a
Remove user from account (Asynchronous).
Remove users from an account by using the user's IAM ID. You must use a user token
for authorization. Service IDs can't remove users from an account. If removing the
user fails it will set the user's state to ERROR_WHILE_DELETING. To use this
method, the requesting user must have the editor or administrator role on the User
Management service. For more information, see the [Removing
users](https://cloud.ibm.com/docs/account?topic=account-remove) documentation.
:param str account_id: The account ID of the specified user.
:param str iam_id: The user's IAM ID.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
r) rc r* v3_remove_userr, r0 r' ra z(/v3/accounts/{account_id}/users/{iam_id}rv r6 r7 r0 r9 r: r r' ra rE r0 rF rG rH rI r7 rJ rK s r r| UserManagementV1.v3_remove_user s . :; ; 67 7% 22 )
{# NN6::i0 1y!'2 1 1* E s? FG8??R/R&& '
99W//r c U( d [ S5 eU( d [ S5 e0 n[ U R SSS9nUR U5 SU; a# UR UR S5 5 US SUS' S S
/nU R X5 n[
[ Xg5 5 nS R " S0 UD6n U R S U US
9n
U R " U
40 UD6n U $ )a
Get user settings.
Retrieve a user's settings by the user's IAM ID. You can use the IAM service token
or a user token for authorization. To use this method, the requesting user or
service ID must have the viewer, editor, or administrator role on the User
Management service.
The user settings have several fields. The
`language` field is the language setting for the user interface display language.
The `notification_language` field is the language setting for phone and email
notifications. The `allowed_ip_addresses` field specifies a list of IP addresses
that the user can log in and perform operations from as described in [Allowing
specific IP addresses for a
user](https://cloud.ibm.com/docs/account?topic=account-ips). For information about
the `self_manage` field, review information about the [user-managed login
setting](https://cloud.ibm.com/docs/account?topic=account-types).
:param str account_id: The account ID of the specified user.
:param str iam_id: The user's IAM ID.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse with `dict` result representing a `UserSettings` object
r) rc r* get_user_settingsr, r0 r1 r2 r' ra 1/v2/accounts/{account_id}/users/{iam_id}/settingsr4 r} r9 r: r~ s r r "UserManagementV1.get_user_settings1 s : :; ; 67 7% 22 ,
{# NN6::i0 1y! .'2 1 1* E s? FGAHH[?[&& '
99W//r languagenotification_languageallowed_ip_addresses self_manager r r r c R U( d [ S5 eU( d [ S5 e0 n[ U R SSS9n UR U 5 UUUUS.n
U
R 5 V V s0 s H u pU c M
X_M n
n n [
R " U
5 n
SUS' S U; a# UR UR S 5 5 US S
S /n
U R X5 n[ [ X5 5 nS R " S0 UD6nU R S
UUU
S9nU R " U40 UD6nU$ s sn n f )a
Partially update user settings.
Update a user's settings by the user's IAM ID. You can use the IAM service token
or a user token for authorization. To fully use this method, the user or service
ID must have the editor or administrator role on the User Management service.
Without these roles, a user can update only their own `language` or
`notification_language` fields. If `self_manage` is `true`, the user can also
update the `allowed_ip_addresses` field.
:param str account_id: The account ID of the specified user.
:param str iam_id: The user's IAM ID.
:param str language: (optional) The console UI language. By default, this
field is empty.
:param str notification_language: (optional) The language for email and
phone notifications. By default, this field is empty.
:param str allowed_ip_addresses: (optional) A comma-separated list of IP
addresses.
:param bool self_manage: (optional) Whether user managed login is enabled.
The default value is `false`.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
r) rc r* update_user_settingsr, r r1 rU r0 r' ra r rq rW r9 rr )r r' ra r r r r rE r0 rF rX r] r^ rG rH rI r7 rJ rK s r r %UserManagementV1.update_user_settingsl sC H :; ; 67 7% 22 /
{# !%:$8&
$(::<A<!1<Azz$ "4 NN6::i0 1y!'2 1 1* E s? FGAHH[?[&& '
99W//) Bs ' D#4D#r9 )N)__name__
__module__ __qualname____firstlineno____doc__r r< classmethodstrr r r intboolr r+ r rT rd rp ru ry r| r r __static_attributes__r9 r r r r ( s )A, 1
(, f$ f
f* !%TT T
T
T T T
Tt %)26#'
LL L! L
./ L Cy
L
Lf !% :: :
:
:B " $\\ \
\
\ \ \ \ \ \ \
\F !% :: :
:
:~ 0 0
0d22 2
2p99 9
9@ %)$( JJ J
J #
J "J J
J Jr r c \ rS rSrSrSSSS.S\S\S\SS4S jjr\S
\SS 4S j5 r \S 5 r
S\4S
jr S r S\4S jr
SS S\4S jrSS S\4S jrSrg) InvitedUseri a
Information about a user that has been invited to join an account.
:attr str email: (optional) The email address associated with the invited user.
:attr str id: (optional) The id associated with the invited user.
:attr str state: (optional) The state of the invitation for the user.
Nrk idrj rk r rj r c ( Xl X l X0l g)a
Initialize a InvitedUser object.
:param str email: (optional) The email address associated with the invited
user.
:param str id: (optional) The id associated with the invited user.
:param str state: (optional) The state of the invitation for the user.
Nr )r rk r rj s r r InvitedUser.__init__ s
r _dictc 0 nSU; a UR S5 US' SU; a UR S5 US' SU; a UR S5 US' U " S0 UD6$ )7Initialize a InvitedUser object from a json dictionary.rk r rj r9 r> r r argss r from_dictInvitedUser.from_dict sa e !IIg .DM 5= 4 DJ e !IIg .DM{T{r c $ U R U5 $ )r r r r s r
_from_dictInvitedUser._from_dict }}U##r c 0 n[ U S5 ( a U R b U R US' [ U S5 ( a U R b U R US' [ U S5 ( a U R b U R US' U$ )1Return a json dictionary representing this model.rk r rj )hasattrrk r rj r r s r to_dictInvitedUser.to_dict su 4 ! !djj&< !ZZE'N 4 477#6 ''E$K 4 ! !djj&< !ZZE'N r c " U R 5 $ r r r s r _to_dictInvitedUser._to_dict ||~ r c H [ R " U R 5 SS9$ )z2Return a `str` version of this InvitedUser object. indentrZ r[ r r s r __str__InvitedUser.__str__ zz$,,.33r otherc j [ XR 5 ( d gU R UR :H $ z=Return `true` when self and other are equal, false otherwise.F
isinstance __class____dict__r r s r __eq__InvitedUser.__eq__ ' % 00}}..r c X:X + $ zAReturn `true` when self and other are not equal, false otherwise.r9 r s r __ne__InvitedUser.__ne__ r r r r r r r r r r r r r r r r r r r r9 r r r r s
& d } $ $ 4 4/M /d / !M !d !r r c \ rS rSrSrSS.S\S SS4S jjr\S \SS 4S
j5 r \S 5 r
S\4S jr S
r S\
4S jrSS S\4S jrSS S\4S jrSrg)InvitedUserListi z
A collection of invited users. This is the response returned by the invite_users
operation.
:attr List[InvitedUser] resources: (optional) The list of users that have been
invited to join the account.
N resourcesr r r c Xl g)z
Initialize a InvitedUserList object.
:param List[InvitedUser] resources: (optional) The list of users that have
been invited to join the account.
Nr )r r s r r InvitedUserList.__init__ s #r r c 0 nSU; a8 UR S5 Vs/ s H n[ R U5 PM snUS' U " S0 UD6$ s snf );Initialize a InvitedUserList object from a json dictionary.r r9 )r> r r r r r r^ s r r InvitedUserList.from_dict sR % CH99[CY ZCYa!6!6q!9CY ZD {T{ ![ A c $ U R U5 $ )r r r s r r InvitedUserList._from_dict' r r c 0 n[ U S5 ( am U R b` / nU R HJ n[ U[ 5 ( a UR U5 M+ UR UR 5 5 ML X!S' U$ )r r )r r r r@ appendr r r resources_listr^ s r r InvitedUserList.to_dict, sn 4 % %$..*D N^^ a&&"))!,"))!))+6 $
"0+ r c " U R 5 $ r r r s r r InvitedUserList._to_dict9 r r c H [ R " U R 5 SS9$ )z6Return a `str` version of this InvitedUserList object.r r r r s r r InvitedUserList.__str__= r r r c j [ XR 5 ( d gU R UR :H $ r r r s r r InvitedUserList.__eq__A r r c X:X + $ r r9 r s r r InvitedUserList.__ne__G r r r r r r r r r r r r r r r r r r r r r r9 r r r r s *. #
& #
# d '8 $ $ 4 4/ - /$ / ! - !$ !r r c
\ rS rSrSrSSSS.S\S\S\S\S \S
S S4 S jjr\ S
\
S S 4S j5 r \ S 5 r S \
4S jr
S rS \4S jrSS S \4S jrSS S \4S jrSrg)UserListiL ae
The users returned.
:attr int total_results: The number of users returned.
:attr int limit: A limit to the number of users returned in a page.
:attr str first_url: (optional) The first URL of the get users API.
:attr str next_url: (optional) The next URL of the get users API.
:attr List[UserProfile] resources: (optional) A list of users in the account.
N) first_urlnext_urlr
total_resultsr" r r r UserProfiler c @ Xl X l X0l X@l XPl g)a{
Initialize a UserList object.
:param int total_results: The number of users returned.
:param int limit: A limit to the number of users returned in a page.
:param str first_url: (optional) The first URL of the get users API.
:param str next_url: (optional) The next URL of the get users API.
:param List[UserProfile] resources: (optional) A list of users in the
account.
N)r r" r r r )r r r" r r r s r r UserList.__init__W s & +
"
"r r c 0 nSU; a UR S5 US' O [ S5 eSU; a UR S5 US' O [ S5 eSU; a UR S5 US' SU; a UR S5 US' SU; a8 UR S5 Vs/ s H n[ R U5 PM snUS' U " S0 UD6$ s snf ) 4Initialize a UserList object from a json dictionary.r z>Required property 'total_results' not present in UserList JSONr" z6Required property 'limit' not present in UserList JSONr r r r9 )r> r; r r r s r r UserList.from_dictp s e #$)IIo$>D ! _` ` e !IIg .DM WX X % % + 6D $yy 4D % CH99[CY ZCYa!6!6q!9CY ZD {T{ ![s C c $ U R U5 $ )r r r s r r UserList._from_dict r r c n 0 n[ U S5 ( a U R b U R US' [ U S5 ( a U R b U R US' [ U S5 ( a U R b U R US' [ U S5 ( a U R b U R US' [ U S5 ( am U R
b` / nU R
HJ n[
U[ 5 ( a UR U5 M+ UR UR 5 5 ML X!S' U$ )r r r" r r r )
r r r" r r r r r@ r r r s r r UserList.to_dict s 4 ) )d.@.@.L%)%7%7E/ " 4 ! !djj&< !ZZE'N 4 % %$..*D!% E+ 4 $ $ )B $
E* 4 % %$..*D N^^ a&&"))!,"))!))+6 $
"0+ r c " U R 5 $ r r r s r r UserList._to_dict r r c H [ R " U R 5 SS9$ )z/Return a `str` version of this UserList object.r r r r s r r UserList.__str__ r r r c j [ XR 5 ( d gU R UR :H $ r r r s r r UserList.__eq__ r r c X:X + $ r r9 r s r r UserList.__ne__ r r )r r" r r r )r r r r r r r r r r r r r r r r r r r r r9 r r r r L s )-## #
#
#
&#
#2 d z & $ $ * 4 4/J /4 / !J !4 !r r c \ rS rSrSrSSSSSSSSSSSSSS.
S\S\S\S\S \S
\S \S \S
\S\S\S\S\SS4 S jjr\S\SS 4S j5 r \S 5 r
S\4S jr S r S\4S jr
SS S\4S jrSS S\4S jrS rg) r i a6
Returned the user profile.
:attr str id: (optional) An alphanumeric value identifying the user profile.
:attr str iam_id: (optional) An alphanumeric value identifying the user's IAM
ID.
:attr str realm: (optional) The realm of the user. The value is either `IBMid`
or `SL`.
:attr str user_id: (optional) The user ID used for login.
:attr str firstname: (optional) The first name of the user.
:attr str lastname: (optional) The last name of the user.
:attr str state: (optional) The state of the user. Possible values are
`PROCESSING`, `PENDING`, `ACTIVE`, `DISABLED_CLASSIC_INFRASTRUCTURE`, and
`VPN_ONLY`.
:attr str email: (optional) The email address of the user.
:attr str phonenumber: (optional) The phone number of the user.
:attr str altphonenumber: (optional) The alternative phone number of the user.
:attr str photo: (optional) A link to a photo of the user.
:attr str account_id: (optional) An alphanumeric value identifying the account
ID.
:attr str added_on: (optional) The timestamp for when the user was added to the
account.
N
r ra realmr& rh ri rj rk rl rm rn r' added_onr ra r r& rh ri rj rk rl rm rn r' r r c
Xl X l X0l X@l XPl X`l Xpl Xl Xl Xl Xl
Xl Xl g)a]
Initialize a UserProfile object.
:param str id: (optional) An alphanumeric value identifying the user
profile.
:param str iam_id: (optional) An alphanumeric value identifying the user's
IAM ID.
:param str realm: (optional) The realm of the user. The value is either
`IBMid` or `SL`.
:param str user_id: (optional) The user ID used for login.
:param str firstname: (optional) The first name of the user.
:param str lastname: (optional) The last name of the user.
:param str state: (optional) The state of the user. Possible values are
`PROCESSING`, `PENDING`, `ACTIVE`, `DISABLED_CLASSIC_INFRASTRUCTURE`, and
`VPN_ONLY`.
:param str email: (optional) The email address of the user.
:param str phonenumber: (optional) The phone number of the user.
:param str altphonenumber: (optional) The alternative phone number of the
user.
:param str photo: (optional) A link to a photo of the user.
:param str account_id: (optional) An alphanumeric value identifying the
account ID.
:param str added_on: (optional) The timestamp for when the user was added
to the account.
Nr )r r ra r r& rh ri rj rk rl rm rn r' r s r r UserProfile.__init__ sH T
"
& ,
$
r r c 0 nSU; a UR S5 US' SU; a UR S5 US' SU; a UR S5 US' SU; a UR S5 US' SU; a UR S5 US' SU; a UR S5 US' SU; a UR S5 US' SU; a UR S5 US' S U; a UR S 5 US ' S
U; a UR S
5 US
' S U; a UR S 5 US ' S U; a UR S 5 US ' S
U; a UR S
5 US
' U " S0 UD6$ )7Initialize a UserProfile object from a json dictionary.r ra r r& rh ri rj rk rl rm rn r' r r9 r r s r r UserProfile.from_dict sm 5= 4 DJ u "YYx 0DN e !IIg .DM #ii 2DO % % + 6D $yy 4D e !IIg .DM e !IIg .DM E !"'))M":D u $%*YY/?%@D! " e !IIg .DM 5 !& "kkE(O 4 ! !djj&< !ZZE'N 4 # # (@ #||E) 4 % %$..*D!% E+ 4 $ $ )B $
E* 4 ! !djj&< !ZZE'N 4 ! !djj&< !ZZE'N 4 ' 'D,<,<,H#'#3#3E- 4) * *t/B/B/N&*&9&9E" # 4 ! !djj&< !ZZE'N 4 & &4??+F"&//E, 4 $ $ )B $
E* r c " U R 5 $ r r r s r r UserProfile._to_dictF r r c H [ R " U R 5 SS9$ )z2Return a `str` version of this UserProfile object.r r r r s r r UserProfile.__str__J r r r c j [ XR 5 ( d gU R UR :H $ r r r s r r UserProfile.__eq__N r r c X:X + $ r r9 r s r r UserProfile.__ne__T r r )
r' r rm rk rh ra r ri rl rn r rj r& r r9 r r r r s; 6 " 6!
6! 6!
6!
6! 6! 6! 6! 6! 6! 6! 6! 6! 6!
!6!p d } > $ $ > 4 4/M /d / !M !d !r r c \ rS rSrSrSSSSS.S\S\S\S\S S4
S
jjr\S \ S S 4S j5 r
\S
5 r S \ 4S jr S r
S \4S jrSS S \4S jrSS S \4S jrSrg) UserSettingsiY a
The user settings returned.
:attr str language: (optional) The console UI language. By default, this field
is empty.
:attr str notification_language: (optional) The language for email and phone
notifications. By default, this field is empty.
:attr str allowed_ip_addresses: (optional) A comma-separated list of IP
addresses.
:attr bool self_manage: (optional) Whether user managed login is enabled. The
default value is `false`.
Nr r r r r r c 4 Xl X l X0l X@l g)a
Initialize a UserSettings object.
:param str language: (optional) The console UI language. By default, this
field is empty.
:param str notification_language: (optional) The language for email and
phone notifications. By default, this field is empty.
:param str allowed_ip_addresses: (optional) A comma-separated list of IP
addresses.
:param bool self_manage: (optional) Whether user managed login is enabled.
The default value is `false`.
Nr )r r r r r s r r UserSettings.__init__g s ( !
%:"$8!&r r c 0 nSU; a UR S5 US' SU; a UR S5 US' SU; a UR S5 US' SU; a UR S5 US' U " S0 UD6$ )8Initialize a UserSettings object from a json dictionary.r r r r r9 r r s r r UserSettings.from_dict s $yy 4D "e +,1II6M,ND( ) !U *+0995K+LD' ( E !"'))M":D {T{r c $ U R U5 $ )r r r s r r UserSettings._from_dict r r c r 0 n[ U S5 ( a U R b U R US' [ U S5 ( a U R b U R US' [ U S5 ( a U R b U R US' [ U S5 ( a U R b U R US' U$ )r r r r r )r r r r r r s r r UserSettings.to_dict s 4 $ $ )B $
E* 40 1 1d6P6P6\-1-G-GE) * 4/ 0 0T5N5N5Z,0,E,EE( ) 4 ' 'D,<,<,H#'#3#3E- r c " U R 5 $ r r r s r r UserSettings._to_dict r r c H [ R " U R 5 SS9$ )z3Return a `str` version of this UserSettings object.r r r r s r r UserSettings.__str__ r r r c j [ XR 5 ( d gU R UR :H $ r r r s r r UserSettings.__eq__ r r c X:X + $ r r9 r s r r UserSettings.__ne__ r r )r r r r )r r r r r r r r r r r r r r r r r r r9 r r r r Y s %)$(
' ' # '
" '
'
'2 d ~ $ $ 4 4/N /t / !N !t !r r c \ rS rSrSrSSS.S\S\SS4S jjr\S \SS 4S
j5 r \S 5 r
S\4S jr S
r S\4S jr
SS S\4S jrSS S\4S jrSrg) Attributei z
An attribute/value pair.
:attr str name: (optional) The name of the attribute.
:attr str value: (optional) The value of the attribute.
Nnamevaluer- r. r c Xl X l g)z
Initialize a Attribute object.
:param str name: (optional) The name of the attribute.
:param str value: (optional) The value of the attribute.
Nr, )r r- r. s r r Attribute.__init__ s
r r c ~ 0 nSU; a UR S5 US' SU; a UR S5 US' U " S0 UD6$ )5Initialize a Attribute object from a json dictionary.r- r. r9 r r s r r Attribute.from_dict sH U? 99V,DL e !IIg .DM{T{r c $ U R U5 $ )r2 r r s r r Attribute._from_dict r r c 0 n[ U S5 ( a U R b U R US' [ U S5 ( a U R b U R US' U$ )r r- r. )r r- r. r s r r Attribute.to_dict sR 4 TYY%: IIE&M 4 ! !djj&< !ZZE'N r c " U R 5 $ r r r s r r Attribute._to_dict r r c H [ R " U R 5 SS9$ )z0Return a `str` version of this Attribute object.r r r r s r r Attribute.__str__ r r r c j [ XR 5 ( d gU R UR :H $ r r r s r r Attribute.__eq__ r r c X:X + $ r r9 r s r r Attribute.__ne__ r r r r9 r r r+ r+ s
d { $ $ 4 4/K /D / !K !D !r r+ c \ rS rSrSrSSS.S\S\SS4S jjr\S \SS 4S
j5 r \S 5 r
S\4S jr S
r S\4S jr
SS S\4S jrSS S\4S jrSrg)rQ i z
Invite a user.
:attr str email: (optional) The email of the user to be invited.
:attr str account_role: (optional) The account role of the user to be invited.
Nrk account_rolerk rB r c Xl X l g)z
Initialize a InviteUser object.
:param str email: (optional) The email of the user to be invited.
:param str account_role: (optional) The account role of the user to be
invited.
NrA )r rk rB s r r InviteUser.__init__ s
(r r c ~ 0 nSU; a UR S5 US' SU; a UR S5 US' U " S0 UD6$ )6Initialize a InviteUser object from a json dictionary.rk rB r9 r r s r r InviteUser.from_dict
sJ e !IIg .DM U "#(99^#->-J$($5$5E. ! r c " U R 5 $ r r r s r r InviteUser._to_dict% r r c H [ R " U R 5 SS9$ )z1Return a `str` version of this InviteUser object.r r r r s r r InviteUser.__str__) r r r c j [ XR 5 ( d gU R UR :H $ r r r s r r InviteUser.__eq__- r r c X:X + $ r r9 r s r r InviteUser.__ne__3 r r )rB rk r r9 r r rQ rQ s ) ) )
) d | $ $ 4 4/L /T / !L !T !r rQ c \ rS rSrSrSSS.S\S\S S\S S
S4S jjr\S \ S
S 4S
j5 r
\S 5 r S
\ 4S jr S r
S
\4S jrSS S
\4S jrSS S
\4S jrSrg)rR i8 z
Invite a user to an IAM policy.
:attr str type: The policy type. This can be either "access" or "authorization".
:attr List[Role] roles: (optional) A list of IAM roles.
:attr List[Resource] resources: (optional) A list of resources.
N)rolesr typerU Roler Resourcer c ( Xl X l X0l g)z
Initialize a InviteUserIamPolicy object.
:param str type: The policy type. This can be either "access" or
"authorization".
:param List[Role] roles: (optional) A list of IAM roles.
:param List[Resource] resources: (optional) A list of resources.
N)rV rU r )r rV rU r s r r InviteUserIamPolicy.__init__A s
"r r c n 0 nSU; a UR S5 US' O [ S5 eSU; a8 UR S5 Vs/ s H n[ R U5 PM snUS' SU; a8 UR S5 Vs/ s H n[ R U5 PM snUS' U " S0 UD6$ s snf s snf )?Initialize a InviteUserIamPolicy object from a json dictionary.rV z@Required property 'type' not present in InviteUserIamPolicy JSONrU r r9 )r> r; rW r rX r s r r InviteUserIamPolicy.from_dictT s U? 99V,DL ab b e 8= '8J K8J1T^^A .8J KDM % @E +@V W@V1!3!3A!6@V WD {T{ L Ws B- B2c $ U R U5 $ )r\ r r s r r InviteUserIamPolicy._from_dictb r r c \ 0 n[ U S5 ( a U R b U R US' [ U S5 ( am U R b` / nU R HJ n[ U[ 5 ( a UR U5 M+ UR UR
5 5 ML X!S' [ U S5 ( am U R b` / nU R HJ n[ U[ 5 ( a UR U5 M+ UR UR
5 5 ML XAS' U$ )r rV rU r )r rV rU r r@ r r r )r r
roles_listr^ r s r r InviteUserIamPolicy.to_dictg s 4 TYY%: IIE&M 4 ! !djj&<JZZ a&& %%a( %%aiik2
('N 4 % %$..*D N^^ a&&"))!,"))!))+6 $
"0+ r c " U R 5 $ r r r s r r InviteUserIamPolicy._to_dict~ r r c H [ R " U R 5 SS9$ )z:Return a `str` version of this InviteUserIamPolicy object.r r r r s r r InviteUserIamPolicy.__str__ r r r c j [ XR 5 ( d gU R UR :H $ r r r s r r InviteUserIamPolicy.__eq__ r r c X:X + $ r r9 r s r r InviteUserIamPolicy.__ne__ r r )r rU rV )r r r r r r r r r r r r r r r r r r r r9 r r rR rR 8 s #&* ## F| #
# #
#& d '< $ $ . 4 4/ 1 /d / ! 1 !d !r rR c \ rS rSrSrSS.S\S SS4S jjr\S \SS 4S
j5 r \S 5 r
S\4S jr S
r S\
4S jrSS S\4S jrSS S\4S jrSrg)rX i zp
A collection of attribute value pairs.
:attr List[Attribute] attributes: (optional) A list of IAM attributes.
N
attributesrm r+ r c Xl g)zh
Initialize a Resource object.
:param List[Attribute] attributes: (optional) A list of IAM attributes.
Nrl )r rm s r r Resource.__init__ s %r r c 0 nSU; a8 UR S5 Vs/ s H n[ R U5 PM snUS' U " S0 UD6$ s snf )4Initialize a Resource object from a json dictionary.rm r9 )r> r+ r r s r r Resource.from_dict sR 5 BG))LBY!ZBYQ)"5"5a"8BY!ZD {T{ "[r c $ U R U5 $ )rq r r s r r Resource._from_dict r r c 0 n[ U S5 ( am U R b` / nU R HJ n[ U[ 5 ( a UR U5 M+ UR UR 5 5 ML X!S' U$ )r rm )r rm r r@ r r )r r attributes_listr^ s r r Resource.to_dict sn 4 & &4??+F O__ a&&#**1-#**199;7 %
#2, r c " U R 5 $ r r r s r r Resource._to_dict r r c H [ R " U R 5 SS9$ )z/Return a `str` version of this Resource object.r r r r s r r Resource.__str__ r r r c j [ XR 5 ( d gU R UR :H $ r r r s r r Resource.__eq__ r r c X:X + $ r r9 r s r r Resource.__ne__ r r r r9 r r rX rX s )-
% %
%
% d z $ $ 4 4/J /4 / !J !4 !r rX c \ rS rSrSrSS.S\SS4S jjr\S\SS 4S j5 r \S
5 r
S\4S jr S r S\4S
jr
SS S\4S jrSS S\4S jrSrg)rW i zi
The role of an IAM policy.
:attr str role_id: (optional) An alphanumeric value identifying the origin.
Nrole_idr r c Xl g)zp
Initialize a Role object.
:param str role_id: (optional) An alphanumeric value identifying the
origin.
Nr )r r s r r
Role.__init__ s r r c J 0 nSU; a UR S5 US' U " S0 UD6$ )0Initialize a Role object from a json dictionary.r r9 r r s r r Role.from_dict s/ #ii 2DO{T{r c $ U R U5 $ )r r r s r r Role._from_dict r r c d 0 n[ U S5 ( a U R b U R US' U$ )r r )r r r s r r Role.to_dict s0 4 # # (@ #||E) r c " U R 5 $ r r r s r r
Role._to_dict r r c H [ R " U R 5 SS9$ )z+Return a `str` version of this Role object.r r r r s r r Role.__str__ r r r c j [ XR 5 ( d gU R UR :H $ r r r s r r Role.__eq__ r r c X:X + $ r r9 r s r r Role.__ne__ r r r r9 r r rW rW s
d v $ $ 4 4/F /t / !F !t !r rW c \ rS rSrSrSSSSS.S\S\S\S\S \S
\S S4S jjr S \4S
jr
S \ \ 4S jr
S \ \ 4S jrSrg)
UsersPageri zH
UsersPager can be used to simplify the use of the "list_users" method.
N)r" r# r$ r& clientr' r" r# r$ r& r c l SU l Xl SS0U l X l X0l X@l XPl X`l g)a
Initialize a UsersPager object.
:param str account_id: The account ID of the specified user.
:param int limit: (optional) The number of results to be returned.
:param bool include_settings: (optional) The user settings to be returned.
Set to true to view language, allowed IP address, and authentication
settings.
:param str search: (optional) The desired search results to be returned. To
view the list of users with the additional search filter, use the following
query options: `firstname`, `lastname`, `email`, `state`, `substate`,
`iam_id`, `realm`, and `userId`. HTML URL encoding for the search query and
`:` must be used. For example, search=state%3AINVALID returns a list of
invalid users. Multiple search queries can be combined to obtain `OR`
results using `,` operator (not URL encoded). For example,
search=state%3AINVALID,email%3Amail.test.ibm.com.
:param str user_id: (optional) Filter users based on their user ID.
TnextN) _has_next_client
_page_context _account_id_limit_include_settings_search_user_id)r r r' r" r# r$ r& s r r UsersPager.__init__ s7 6 $d^% !1
r c U R $ )zE
Returns true if there are potentially more results to be retrieved.
)r r s r has_nextUsersPager.has_next: s ~~ r c
U R 5 ( d [ SS9eU R R U R U R
U R U R U R U R R S5 S9R 5 nSnUR S5 nUb [ US5 nX R S' Uc SU l
UR S 5 $ )
z
Returns the next page of results.
:return: A List[dict], where each element is a dict that represents an instance of UserProfile.
:rtype: List[dict]
zNo more results available)messager )r' r" r# r$ r& r% Nr r/ Fr )r
StopIterationr r+ r r r r r r r>
get_resultr r )r resultr next_page_links r get_nextUsersPager.get_next@ s }} (CD D ((''++ ! 3 3<<MM$$((0
)
*, J/ %">8r s & M M I S 2 #N
{ N
lH! H!V@! @!Fb! b!Je! e!PW! W!t?! ?!D@! @!FV! V!r=! =!@8! 8!@V Vr