Users¶
create_user¶
-
dome9.dome9.Dome9.
create_user
(self, email, name, surname='') Create user in Dome9
Parameters: - email (str) – User email of the new user
- name (str) – Name of the new user
- surname (str, optional) – Surname of the new user. Defaults to “”
Returns: User object. Ref: /docs/source/schemas/User.json
Return type: dict
- Response object:
{ "id": 0, "name": "string", "email": "MyName@gmail.com", "accountId": 0, "isSuspended": true, "isOwner": true, "isSuperUser": true, "isAuditor": true, "hasApiKey": true, "hasApiKeyV1": true, "hasApiKeyV2": true, "isMfaEnabled": true, "ssoEnabled": true, "roleIds": [ 0 ], "iamSafe": null, "canSwitchRole": true, "isLocked": true, "lastLogin": "2022-05-24T17:41:03Z", "permissions": null, "calculatedPermissions": null, "isMobileDevicePaired": true, "mfaEnforcement": null }
list_users¶
-
dome9.dome9.Dome9.
list_users
(self) List all Dome9 users for the Dome9 account
Returns: User object. Ref: /docs/source/schemas/User.json Return type: dict - Response object:
{ "id": 0, "name": "string", "email": "MyName@gmail.com", "accountId": 0, "isSuspended": true, "isOwner": true, "isSuperUser": true, "isAuditor": true, "hasApiKey": true, "hasApiKeyV1": true, "hasApiKeyV2": true, "isMfaEnabled": true, "ssoEnabled": true, "roleIds": [ 0 ], "iamSafe": null, "canSwitchRole": true, "isLocked": true, "lastLogin": "2022-05-24T17:41:03Z", "permissions": null, "calculatedPermissions": null, "isMobileDevicePaired": true, "mfaEnforcement": null }
get_user¶
-
dome9.dome9.Dome9.
get_user
(self, userId) Get user registered in Dome9
Parameters: userId (id) – Id of the user Returns: User object. Ref: /docs/source/schemas/User.json Return type: dict - Response object:
{ "id": 0, "name": "string", "email": "MyName@gmail.com", "accountId": 0, "isSuspended": true, "isOwner": true, "isSuperUser": true, "isAuditor": true, "hasApiKey": true, "hasApiKeyV1": true, "hasApiKeyV2": true, "isMfaEnabled": true, "ssoEnabled": true, "roleIds": [ 0 ], "iamSafe": null, "canSwitchRole": true, "isLocked": true, "lastLogin": "2022-05-24T17:41:03Z", "permissions": null, "calculatedPermissions": null, "isMobileDevicePaired": true, "mfaEnforcement": null }
delete_user¶
-
dome9.dome9.Dome9.
delete_user
(self, userId) Delete a user in Dome9
Parameters: userId (str) – Id of the user Returns: bool