Returns the aliases Resource.
Returns the photos Resource.
Close httplib2 connections.
delete(userKey, x__xgafv=None)
Delete user
get(userKey, customFieldMask=None, projection=None, viewType=None, x__xgafv=None)
retrieve user
insert(body=None, x__xgafv=None)
create user.
Retrieve either deleted users or all users in a domain (paginated)
list_next(previous_request, previous_response)
Retrieves the next page of results.
makeAdmin(userKey, body=None, x__xgafv=None)
change admin status of a user
patch(userKey, body=None, x__xgafv=None)
Patch Users via Apiary Patch Orchestration
signOut(userKey, x__xgafv=None)
Sign a user out of all web and device sessions and reset their sign-in cookies. User will have to sign in by authenticating again.
undelete(userKey, body=None, x__xgafv=None)
Undelete a deleted user
update(userKey, body=None, x__xgafv=None)
update user
Watch for changes in users list
close()
Close httplib2 connections.
delete(userKey, x__xgafv=None)
Delete user Args: userKey: string, Email or immutable ID of the user (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format
get(userKey, customFieldMask=None, projection=None, viewType=None, x__xgafv=None)
retrieve user Args: userKey: string, Email or immutable ID of the user (required) customFieldMask: string, Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. projection: string, What subset of fields to fetch for this user. Allowed values projectionUndefined - basic - Do not include any custom fields for the user. custom - Include custom fields from schemas mentioned in customFieldMask. full - Include all fields associated with this user. viewType: string, Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. Allowed values view_type_undefined - admin_view - Fetches the ADMIN_VIEW of the user. domain_public - Fetches the DOMAIN_PUBLIC view of the user. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'external_ids' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'relations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'addresses' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'organizations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'phones' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'languages' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'posix_accounts' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'ssh_public_keys' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'notes' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'websites' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'locations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'keywords' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'gender' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'thumbnail_photo_etag' to avoid collision. (See http://go/stepladder-help#fieldNumber) "notes": "", # Notes of User "deletionTime": "A String", "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt "gender": "", # Gender of User "lastLoginTime": "A String", # User's last login time. (Read-only) "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List "isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only) "recoveryEmail": "A String", # Recovery email of the user. "customSchemas": { # Custom fields of the user. "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) "a_key": "", }, }, "languages": "", # Languages of User "nonEditableAliases": [ # Output only. List of non editable aliases (Read-only) "A String", ], "thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only) "orgUnitPath": "A String", # OrgUnit of User "posixAccounts": "", # The POSIX accounts of User "thumbnailPhotoUrl": "A String", # Output only. Photo Url of the user (Read-only) "relations": "", # The Relations of User * "suspensionReason": "A String", # Output only. Suspension reason if user is suspended (Read-only) "recoveryPhone": "A String", # Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*. "sshPublicKeys": "", # The SSH public keys of User "phones": "", # Phone numbers of User "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted "suspended": True or False, # Indicates if user is suspended. "password": "A String", # User's password "customerId": "A String", # Output only. CustomerId of User (Read-only) "organizations": "", # Organizations of User "locations": "", # Locations of User "etag": "A String", # Output only. ETag of the resource. "id": "A String", # Unique identifier of User (Read-only) "isDelegatedAdmin": True or False, # Output only. Boolean indicating if the user is delegated admin (Read-only) "kind": "admin#directory#user", # Output only. Kind of resource this is. "creationTime": "A String", # User's G Suite account creation time. (Read-only) "primaryEmail": "A String", # username of User "emails": "", # Emails of User "agreedToTerms": True or False, # Output only. Indicates if user has agreed to terms (Read-only) "addresses": "", # Addresses of User "isMailboxSetup": True or False, # Output only. Is mailbox setup (Read-only) "ims": "", # User's Instant Messenger "isAdmin": True or False, # Output only. Boolean indicating if the user is admin (Read-only) "keywords": "", # Keywords of User "name": { # User's name "givenName": "A String", # First Name "fullName": "A String", # Full Name "familyName": "A String", # Last Name }, "aliases": [ # Output only. List of aliases (Read-only) "A String", ], "websites": "", # Websites of User "archived": True or False, # Indicates if user is archived. "isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only) "externalIds": "", # The external Ids of User * }
insert(body=None, x__xgafv=None)
create user. Args: body: object, The request body. The object takes the form of: { # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'external_ids' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'relations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'addresses' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'organizations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'phones' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'languages' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'posix_accounts' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'ssh_public_keys' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'notes' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'websites' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'locations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'keywords' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'gender' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'thumbnail_photo_etag' to avoid collision. (See http://go/stepladder-help#fieldNumber) "notes": "", # Notes of User "deletionTime": "A String", "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt "gender": "", # Gender of User "lastLoginTime": "A String", # User's last login time. (Read-only) "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List "isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only) "recoveryEmail": "A String", # Recovery email of the user. "customSchemas": { # Custom fields of the user. "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) "a_key": "", }, }, "languages": "", # Languages of User "nonEditableAliases": [ # Output only. List of non editable aliases (Read-only) "A String", ], "thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only) "orgUnitPath": "A String", # OrgUnit of User "posixAccounts": "", # The POSIX accounts of User "thumbnailPhotoUrl": "A String", # Output only. Photo Url of the user (Read-only) "relations": "", # The Relations of User * "suspensionReason": "A String", # Output only. Suspension reason if user is suspended (Read-only) "recoveryPhone": "A String", # Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*. "sshPublicKeys": "", # The SSH public keys of User "phones": "", # Phone numbers of User "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted "suspended": True or False, # Indicates if user is suspended. "password": "A String", # User's password "customerId": "A String", # Output only. CustomerId of User (Read-only) "organizations": "", # Organizations of User "locations": "", # Locations of User "etag": "A String", # Output only. ETag of the resource. "id": "A String", # Unique identifier of User (Read-only) "isDelegatedAdmin": True or False, # Output only. Boolean indicating if the user is delegated admin (Read-only) "kind": "admin#directory#user", # Output only. Kind of resource this is. "creationTime": "A String", # User's G Suite account creation time. (Read-only) "primaryEmail": "A String", # username of User "emails": "", # Emails of User "agreedToTerms": True or False, # Output only. Indicates if user has agreed to terms (Read-only) "addresses": "", # Addresses of User "isMailboxSetup": True or False, # Output only. Is mailbox setup (Read-only) "ims": "", # User's Instant Messenger "isAdmin": True or False, # Output only. Boolean indicating if the user is admin (Read-only) "keywords": "", # Keywords of User "name": { # User's name "givenName": "A String", # First Name "fullName": "A String", # Full Name "familyName": "A String", # Last Name }, "aliases": [ # Output only. List of aliases (Read-only) "A String", ], "websites": "", # Websites of User "archived": True or False, # Indicates if user is archived. "isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only) "externalIds": "", # The external Ids of User * } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'external_ids' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'relations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'addresses' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'organizations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'phones' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'languages' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'posix_accounts' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'ssh_public_keys' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'notes' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'websites' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'locations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'keywords' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'gender' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'thumbnail_photo_etag' to avoid collision. (See http://go/stepladder-help#fieldNumber) "notes": "", # Notes of User "deletionTime": "A String", "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt "gender": "", # Gender of User "lastLoginTime": "A String", # User's last login time. (Read-only) "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List "isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only) "recoveryEmail": "A String", # Recovery email of the user. "customSchemas": { # Custom fields of the user. "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) "a_key": "", }, }, "languages": "", # Languages of User "nonEditableAliases": [ # Output only. List of non editable aliases (Read-only) "A String", ], "thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only) "orgUnitPath": "A String", # OrgUnit of User "posixAccounts": "", # The POSIX accounts of User "thumbnailPhotoUrl": "A String", # Output only. Photo Url of the user (Read-only) "relations": "", # The Relations of User * "suspensionReason": "A String", # Output only. Suspension reason if user is suspended (Read-only) "recoveryPhone": "A String", # Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*. "sshPublicKeys": "", # The SSH public keys of User "phones": "", # Phone numbers of User "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted "suspended": True or False, # Indicates if user is suspended. "password": "A String", # User's password "customerId": "A String", # Output only. CustomerId of User (Read-only) "organizations": "", # Organizations of User "locations": "", # Locations of User "etag": "A String", # Output only. ETag of the resource. "id": "A String", # Unique identifier of User (Read-only) "isDelegatedAdmin": True or False, # Output only. Boolean indicating if the user is delegated admin (Read-only) "kind": "admin#directory#user", # Output only. Kind of resource this is. "creationTime": "A String", # User's G Suite account creation time. (Read-only) "primaryEmail": "A String", # username of User "emails": "", # Emails of User "agreedToTerms": True or False, # Output only. Indicates if user has agreed to terms (Read-only) "addresses": "", # Addresses of User "isMailboxSetup": True or False, # Output only. Is mailbox setup (Read-only) "ims": "", # User's Instant Messenger "isAdmin": True or False, # Output only. Boolean indicating if the user is admin (Read-only) "keywords": "", # Keywords of User "name": { # User's name "givenName": "A String", # First Name "fullName": "A String", # Full Name "familyName": "A String", # Last Name }, "aliases": [ # Output only. List of aliases (Read-only) "A String", ], "websites": "", # Websites of User "archived": True or False, # Indicates if user is archived. "isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only) "externalIds": "", # The external Ids of User * }
list(pageToken=None, query=None, maxResults=None, viewType=None, showDeleted=None, projection=None, sortOrder=None, domain=None, customer=None, orderBy=None, customFieldMask=None, x__xgafv=None)
Retrieve either deleted users or all users in a domain (paginated) Args: pageToken: string, Token to specify next page in the list query: string, Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-users maxResults: integer, Maximum number of results to return. viewType: string, Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. Allowed values view_type_undefined - admin_view - Fetches the ADMIN_VIEW of the user. domain_public - Fetches the DOMAIN_PUBLIC view of the user. showDeleted: string, If set to true, retrieves the list of deleted users. (Default: false) projection: string, What subset of fields to fetch for this user. Allowed values projectionUndefined - basic - Do not include any custom fields for the user. custom - Include custom fields from schemas mentioned in customFieldMask. full - Include all fields associated with this user. sortOrder: string, Whether to return results in ascending or descending order. Allowed values SORT_ORDER_UNDEFINED - ASCENDING - Ascending order. DESCENDING - Descending order. domain: string, Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead. customer: string, Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain. orderBy: string, Column to use for sorting results Allowed values orderByUndefined - email - Primary email of the user. familyName - User's family name. givenName - User's given name. customFieldMask: string, Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber) "users": [ # List of user objects. { # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'external_ids' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'relations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'addresses' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'organizations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'phones' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'languages' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'posix_accounts' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'ssh_public_keys' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'notes' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'websites' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'locations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'keywords' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'gender' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'thumbnail_photo_etag' to avoid collision. (See http://go/stepladder-help#fieldNumber) "notes": "", # Notes of User "deletionTime": "A String", "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt "gender": "", # Gender of User "lastLoginTime": "A String", # User's last login time. (Read-only) "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List "isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only) "recoveryEmail": "A String", # Recovery email of the user. "customSchemas": { # Custom fields of the user. "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) "a_key": "", }, }, "languages": "", # Languages of User "nonEditableAliases": [ # Output only. List of non editable aliases (Read-only) "A String", ], "thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only) "orgUnitPath": "A String", # OrgUnit of User "posixAccounts": "", # The POSIX accounts of User "thumbnailPhotoUrl": "A String", # Output only. Photo Url of the user (Read-only) "relations": "", # The Relations of User * "suspensionReason": "A String", # Output only. Suspension reason if user is suspended (Read-only) "recoveryPhone": "A String", # Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*. "sshPublicKeys": "", # The SSH public keys of User "phones": "", # Phone numbers of User "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted "suspended": True or False, # Indicates if user is suspended. "password": "A String", # User's password "customerId": "A String", # Output only. CustomerId of User (Read-only) "organizations": "", # Organizations of User "locations": "", # Locations of User "etag": "A String", # Output only. ETag of the resource. "id": "A String", # Unique identifier of User (Read-only) "isDelegatedAdmin": True or False, # Output only. Boolean indicating if the user is delegated admin (Read-only) "kind": "admin#directory#user", # Output only. Kind of resource this is. "creationTime": "A String", # User's G Suite account creation time. (Read-only) "primaryEmail": "A String", # username of User "emails": "", # Emails of User "agreedToTerms": True or False, # Output only. Indicates if user has agreed to terms (Read-only) "addresses": "", # Addresses of User "isMailboxSetup": True or False, # Output only. Is mailbox setup (Read-only) "ims": "", # User's Instant Messenger "isAdmin": True or False, # Output only. Boolean indicating if the user is admin (Read-only) "keywords": "", # Keywords of User "name": { # User's name "givenName": "A String", # First Name "fullName": "A String", # Full Name "familyName": "A String", # Last Name }, "aliases": [ # Output only. List of aliases (Read-only) "A String", ], "websites": "", # Websites of User "archived": True or False, # Indicates if user is archived. "isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only) "externalIds": "", # The external Ids of User * }, ], "trigger_event": "A String", # Event that triggered this response (only used in case of Push Response) "nextPageToken": "A String", # Token used to access next page of this result. "etag": "A String", # ETag of the resource. "kind": "admin#directory#users", # Kind of resource this is. }
list_next(previous_request, previous_response)
Retrieves the next page of results. Args: previous_request: The request for the previous page. (required) previous_response: The response from the request for the previous page. (required) Returns: A request object that you can call 'execute()' on to request the next page. Returns None if there are no more items in the collection.
makeAdmin(userKey, body=None, x__xgafv=None)
change admin status of a user Args: userKey: string, Email or immutable ID of the user as admin (required) body: object, The request body. The object takes the form of: { "status": True or False, # Boolean indicating new admin status of the user } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format
patch(userKey, body=None, x__xgafv=None)
Patch Users via Apiary Patch Orchestration Args: userKey: string, Email or immutable ID of the user. If ID, it should match with id of user object (required) body: object, The request body. The object takes the form of: { # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'external_ids' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'relations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'addresses' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'organizations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'phones' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'languages' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'posix_accounts' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'ssh_public_keys' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'notes' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'websites' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'locations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'keywords' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'gender' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'thumbnail_photo_etag' to avoid collision. (See http://go/stepladder-help#fieldNumber) "notes": "", # Notes of User "deletionTime": "A String", "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt "gender": "", # Gender of User "lastLoginTime": "A String", # User's last login time. (Read-only) "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List "isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only) "recoveryEmail": "A String", # Recovery email of the user. "customSchemas": { # Custom fields of the user. "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) "a_key": "", }, }, "languages": "", # Languages of User "nonEditableAliases": [ # Output only. List of non editable aliases (Read-only) "A String", ], "thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only) "orgUnitPath": "A String", # OrgUnit of User "posixAccounts": "", # The POSIX accounts of User "thumbnailPhotoUrl": "A String", # Output only. Photo Url of the user (Read-only) "relations": "", # The Relations of User * "suspensionReason": "A String", # Output only. Suspension reason if user is suspended (Read-only) "recoveryPhone": "A String", # Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*. "sshPublicKeys": "", # The SSH public keys of User "phones": "", # Phone numbers of User "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted "suspended": True or False, # Indicates if user is suspended. "password": "A String", # User's password "customerId": "A String", # Output only. CustomerId of User (Read-only) "organizations": "", # Organizations of User "locations": "", # Locations of User "etag": "A String", # Output only. ETag of the resource. "id": "A String", # Unique identifier of User (Read-only) "isDelegatedAdmin": True or False, # Output only. Boolean indicating if the user is delegated admin (Read-only) "kind": "admin#directory#user", # Output only. Kind of resource this is. "creationTime": "A String", # User's G Suite account creation time. (Read-only) "primaryEmail": "A String", # username of User "emails": "", # Emails of User "agreedToTerms": True or False, # Output only. Indicates if user has agreed to terms (Read-only) "addresses": "", # Addresses of User "isMailboxSetup": True or False, # Output only. Is mailbox setup (Read-only) "ims": "", # User's Instant Messenger "isAdmin": True or False, # Output only. Boolean indicating if the user is admin (Read-only) "keywords": "", # Keywords of User "name": { # User's name "givenName": "A String", # First Name "fullName": "A String", # Full Name "familyName": "A String", # Last Name }, "aliases": [ # Output only. List of aliases (Read-only) "A String", ], "websites": "", # Websites of User "archived": True or False, # Indicates if user is archived. "isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only) "externalIds": "", # The external Ids of User * } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'external_ids' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'relations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'addresses' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'organizations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'phones' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'languages' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'posix_accounts' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'ssh_public_keys' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'notes' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'websites' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'locations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'keywords' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'gender' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'thumbnail_photo_etag' to avoid collision. (See http://go/stepladder-help#fieldNumber) "notes": "", # Notes of User "deletionTime": "A String", "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt "gender": "", # Gender of User "lastLoginTime": "A String", # User's last login time. (Read-only) "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List "isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only) "recoveryEmail": "A String", # Recovery email of the user. "customSchemas": { # Custom fields of the user. "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) "a_key": "", }, }, "languages": "", # Languages of User "nonEditableAliases": [ # Output only. List of non editable aliases (Read-only) "A String", ], "thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only) "orgUnitPath": "A String", # OrgUnit of User "posixAccounts": "", # The POSIX accounts of User "thumbnailPhotoUrl": "A String", # Output only. Photo Url of the user (Read-only) "relations": "", # The Relations of User * "suspensionReason": "A String", # Output only. Suspension reason if user is suspended (Read-only) "recoveryPhone": "A String", # Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*. "sshPublicKeys": "", # The SSH public keys of User "phones": "", # Phone numbers of User "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted "suspended": True or False, # Indicates if user is suspended. "password": "A String", # User's password "customerId": "A String", # Output only. CustomerId of User (Read-only) "organizations": "", # Organizations of User "locations": "", # Locations of User "etag": "A String", # Output only. ETag of the resource. "id": "A String", # Unique identifier of User (Read-only) "isDelegatedAdmin": True or False, # Output only. Boolean indicating if the user is delegated admin (Read-only) "kind": "admin#directory#user", # Output only. Kind of resource this is. "creationTime": "A String", # User's G Suite account creation time. (Read-only) "primaryEmail": "A String", # username of User "emails": "", # Emails of User "agreedToTerms": True or False, # Output only. Indicates if user has agreed to terms (Read-only) "addresses": "", # Addresses of User "isMailboxSetup": True or False, # Output only. Is mailbox setup (Read-only) "ims": "", # User's Instant Messenger "isAdmin": True or False, # Output only. Boolean indicating if the user is admin (Read-only) "keywords": "", # Keywords of User "name": { # User's name "givenName": "A String", # First Name "fullName": "A String", # Full Name "familyName": "A String", # Last Name }, "aliases": [ # Output only. List of aliases (Read-only) "A String", ], "websites": "", # Websites of User "archived": True or False, # Indicates if user is archived. "isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only) "externalIds": "", # The external Ids of User * }
signOut(userKey, x__xgafv=None)
Sign a user out of all web and device sessions and reset their sign-in cookies. User will have to sign in by authenticating again. Args: userKey: string, Identifies the target user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format
undelete(userKey, body=None, x__xgafv=None)
Undelete a deleted user Args: userKey: string, The immutable id of the user (required) body: object, The request body. The object takes the form of: { "orgUnitPath": "A String", # OrgUnit of User } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format
update(userKey, body=None, x__xgafv=None)
update user Args: userKey: string, Email or immutable ID of the user. If ID, it should match with id of user object (required) body: object, The request body. The object takes the form of: { # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'external_ids' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'relations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'addresses' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'organizations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'phones' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'languages' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'posix_accounts' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'ssh_public_keys' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'notes' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'websites' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'locations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'keywords' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'gender' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'thumbnail_photo_etag' to avoid collision. (See http://go/stepladder-help#fieldNumber) "notes": "", # Notes of User "deletionTime": "A String", "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt "gender": "", # Gender of User "lastLoginTime": "A String", # User's last login time. (Read-only) "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List "isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only) "recoveryEmail": "A String", # Recovery email of the user. "customSchemas": { # Custom fields of the user. "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) "a_key": "", }, }, "languages": "", # Languages of User "nonEditableAliases": [ # Output only. List of non editable aliases (Read-only) "A String", ], "thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only) "orgUnitPath": "A String", # OrgUnit of User "posixAccounts": "", # The POSIX accounts of User "thumbnailPhotoUrl": "A String", # Output only. Photo Url of the user (Read-only) "relations": "", # The Relations of User * "suspensionReason": "A String", # Output only. Suspension reason if user is suspended (Read-only) "recoveryPhone": "A String", # Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*. "sshPublicKeys": "", # The SSH public keys of User "phones": "", # Phone numbers of User "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted "suspended": True or False, # Indicates if user is suspended. "password": "A String", # User's password "customerId": "A String", # Output only. CustomerId of User (Read-only) "organizations": "", # Organizations of User "locations": "", # Locations of User "etag": "A String", # Output only. ETag of the resource. "id": "A String", # Unique identifier of User (Read-only) "isDelegatedAdmin": True or False, # Output only. Boolean indicating if the user is delegated admin (Read-only) "kind": "admin#directory#user", # Output only. Kind of resource this is. "creationTime": "A String", # User's G Suite account creation time. (Read-only) "primaryEmail": "A String", # username of User "emails": "", # Emails of User "agreedToTerms": True or False, # Output only. Indicates if user has agreed to terms (Read-only) "addresses": "", # Addresses of User "isMailboxSetup": True or False, # Output only. Is mailbox setup (Read-only) "ims": "", # User's Instant Messenger "isAdmin": True or False, # Output only. Boolean indicating if the user is admin (Read-only) "keywords": "", # Keywords of User "name": { # User's name "givenName": "A String", # First Name "fullName": "A String", # Full Name "familyName": "A String", # Last Name }, "aliases": [ # Output only. List of aliases (Read-only) "A String", ], "websites": "", # Websites of User "archived": True or False, # Indicates if user is archived. "isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only) "externalIds": "", # The external Ids of User * } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'external_ids' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'relations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'addresses' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'organizations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'phones' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'languages' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'posix_accounts' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'ssh_public_keys' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'notes' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'websites' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'locations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'keywords' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'gender' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'thumbnail_photo_etag' to avoid collision. (See http://go/stepladder-help#fieldNumber) "notes": "", # Notes of User "deletionTime": "A String", "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt "gender": "", # Gender of User "lastLoginTime": "A String", # User's last login time. (Read-only) "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List "isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only) "recoveryEmail": "A String", # Recovery email of the user. "customSchemas": { # Custom fields of the user. "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) "a_key": "", }, }, "languages": "", # Languages of User "nonEditableAliases": [ # Output only. List of non editable aliases (Read-only) "A String", ], "thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only) "orgUnitPath": "A String", # OrgUnit of User "posixAccounts": "", # The POSIX accounts of User "thumbnailPhotoUrl": "A String", # Output only. Photo Url of the user (Read-only) "relations": "", # The Relations of User * "suspensionReason": "A String", # Output only. Suspension reason if user is suspended (Read-only) "recoveryPhone": "A String", # Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*. "sshPublicKeys": "", # The SSH public keys of User "phones": "", # Phone numbers of User "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted "suspended": True or False, # Indicates if user is suspended. "password": "A String", # User's password "customerId": "A String", # Output only. CustomerId of User (Read-only) "organizations": "", # Organizations of User "locations": "", # Locations of User "etag": "A String", # Output only. ETag of the resource. "id": "A String", # Unique identifier of User (Read-only) "isDelegatedAdmin": True or False, # Output only. Boolean indicating if the user is delegated admin (Read-only) "kind": "admin#directory#user", # Output only. Kind of resource this is. "creationTime": "A String", # User's G Suite account creation time. (Read-only) "primaryEmail": "A String", # username of User "emails": "", # Emails of User "agreedToTerms": True or False, # Output only. Indicates if user has agreed to terms (Read-only) "addresses": "", # Addresses of User "isMailboxSetup": True or False, # Output only. Is mailbox setup (Read-only) "ims": "", # User's Instant Messenger "isAdmin": True or False, # Output only. Boolean indicating if the user is admin (Read-only) "keywords": "", # Keywords of User "name": { # User's name "givenName": "A String", # First Name "fullName": "A String", # Full Name "familyName": "A String", # Last Name }, "aliases": [ # Output only. List of aliases (Read-only) "A String", ], "websites": "", # Websites of User "archived": True or False, # Indicates if user is archived. "isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only) "externalIds": "", # The external Ids of User * }
watch(body=None, sortOrder=None, pageToken=None, customer=None, viewType=None, projection=None, maxResults=None, domain=None, customFieldMask=None, orderBy=None, showDeleted=None, event=None, query=None, x__xgafv=None)
Watch for changes in users list Args: body: object, The request body. The object takes the form of: { # An notification channel used to watch for resource changes. "id": "A String", # A UUID or similar unique string that identifies this channel. "address": "A String", # The address where notifications are delivered for this channel. "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. "params": { # Additional parameters controlling delivery channel behavior. Optional. "a_key": "A String", }, "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. "resourceUri": "A String", # A version-specific identifier for the watched resource. "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". "type": "A String", # The type of delivery mechanism used for this channel. } sortOrder: string, Whether to return results in ascending or descending order. Allowed values sortOrderUnspecified - ASCENDING - Ascending order. DESCENDING - Descending order. pageToken: string, Token to specify next page in the list customer: string, Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain. viewType: string, Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. Allowed values admin_view - Fetches the ADMIN_VIEW of the user. domain_public - Fetches the DOMAIN_PUBLIC view of the user. projection: string, What subset of fields to fetch for this user. Allowed values projectionUnspecified - basic - Do not include any custom fields for the user. custom - Include custom fields from schemas mentioned in customFieldMask. full - Include all fields associated with this user. maxResults: integer, Maximum number of results to return. domain: string, Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead." customFieldMask: string, Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. orderBy: string, Column to use for sorting results Allowed values orderByUnspecified - email - Primary email of the user. familyName - User's family name. givenName - User's given name. showDeleted: string, If set to true, retrieves the list of deleted users. (Default: false) event: string, Event on which subscription is intended Allowed values eventTypeUnspecified - add - User Created Event delete - User Deleted Event makeAdmin - User Admin Status Change Event undelete - User Undeleted Event update - User Updated Event query: string, Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-users x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # An notification channel used to watch for resource changes. "id": "A String", # A UUID or similar unique string that identifies this channel. "address": "A String", # The address where notifications are delivered for this channel. "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. "params": { # Additional parameters controlling delivery channel behavior. Optional. "a_key": "A String", }, "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. "resourceUri": "A String", # A version-specific identifier for the watched resource. "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". "type": "A String", # The type of delivery mechanism used for this channel. }