users

Overview

Name	users
Type	Resource
Id	linode.account.users

Fields

Name	Datatype	Description
email	string	The email address for the User. Linode sends emails to this address for account management communications. May be used for other communications as configured.
restricted	boolean	If true, the User must be granted access to perform actions or access entities on this Account. See User Grants View (GET /account/users/{username}/grants) for details on how to configure grants for a restricted User.
ssh_keys	array	A list of SSH Key labels added by this User. Users can add keys with the SSH Key Add (POST /profile/sshkeys) command. These keys are deployed when this User is included in the authorized_users field of the following requests: - Linode Create (POST /linode/instances) - Linode Rebuild (POST /linode/instances/{linodeId}/rebuild) - Disk Create (POST /linode/instances/{linodeId}/disks)
tfa_enabled	boolean	A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. See the Create Two Factor Secret (POST /profile/tfa-enable) endpoint to enable TFA.
username	string	The User's username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts).

Methods

Name	Accessible by	Required Params	Description
getUser	SELECT	username	Returns information about a single User on your Account. This command can only be accessed by the unrestricted users of an account.
getUsers	SELECT		Returns a paginated list of Users on your Account. This command can only be accessed by the unrestricted users of an account. Users may access all or part of your Account based on their restricted status and grants. An unrestricted User may access everything on the account, whereas restricted User may only access entities or perform actions they've been given specific grants to.
createUser	INSERT	data__email, data__username	Creates a User on your Account. Once created, a confirmation message containing password creation and login instructions is sent to the User's email address. This command can only be accessed by the unrestricted users of an account. The User's account access is determined by whether or not they are restricted, and what grants they have been given.
deleteUser	DELETE	username	Deletes a User. The deleted User will be immediately logged out and may no longer log in or perform any actions. All of the User's Grants will be removed. This command can only be accessed by the unrestricted users of an account.
_getUser	EXEC	username	Returns information about a single User on your Account. This command can only be accessed by the unrestricted users of an account.
_getUserGrants	EXEC	username	Returns the full grants structure for the specified account User (other than the account owner, see below for details). This includes all entities on the Account alongside the level of access this User has to each of them. This command can only be accessed by the unrestricted users of an account. The current authenticated User, including the account owner, may view their own grants at the /profile/grants endpoint, but will not see entities that they do not have access to.
_getUsers	EXEC		Returns a paginated list of Users on your Account. This command can only be accessed by the unrestricted users of an account. Users may access all or part of your Account based on their restricted status and grants. An unrestricted User may access everything on the account, whereas restricted User may only access entities or perform actions they've been given specific grants to.
getUserGrants	EXEC	username	Returns the full grants structure for the specified account User (other than the account owner, see below for details). This includes all entities on the Account alongside the level of access this User has to each of them. This command can only be accessed by the unrestricted users of an account. The current authenticated User, including the account owner, may view their own grants at the /profile/grants endpoint, but will not see entities that they do not have access to.
updateUser	EXEC	username	Update information about a User on your Account. This can be used to change the restricted status of a User. When making a User restricted, no grants will be configured by default and you must then set up grants in order for the User to access anything on the Account. This command can only be accessed by the unrestricted users of an account.
updateUserGrants	EXEC	username	Update the grants a User has. This can be used to give a User access to new entities or actions, or take access away. You do not need to include the grant for every entity on the Account in this request; any that are not included will remain unchanged. This command can only be accessed by the unrestricted users of an account.