openapi: 3.2.0 info: contact: email: support@linode.com name: Linode url: https://linode.com description: Add a Cloud Computing instance so you can build, release, and scale applications faster with virtual machines. license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: 'Akamai: Linode Users API' version: 4.215.0 servers: - url: https://api.linode.com tags: - description: Users are individuals on your account that you set up to perform specific tasks. Use these operations to view and manage users, including giving them various levels of access to the services on your account. name: Users paths: /{apiVersion}/account/users: parameters: - description: __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. example: '{{apiVersion}}' in: path name: apiVersion required: true schema: enum: - v4 - v4beta type: string x-akamai: file-path: parameters/api-version-path.yaml x-akamai: file-path: paths/users.yaml path-info: /{apiVersion}/account/users x-linode-cli-command: users post: description: 'Creates a user on your account. You determine the new user''s account access by setting it to restricted or unrestricted and by defining its grants. After completion, the API sends a confirmation message containing password creation and login instructions to the user''s `email` address. > 📘 > > This operation can only be accessed by account users with _unrestricted_ access. Talk to your local account administrator about access management. __Parent and child accounts__ In a parent and child account environment, the following apply: - A parent account user can create new parent account users. - A child account can update the child account parent user (proxy user) to `unrestricted`. This gives the proxy user access to create new child account users. - A child account user can create new child account users. - You can''t create a proxy user. The proxy user in a child account is predefined when you initially provision the parent-child relationship. > --- - __CLI__. ``` linode-cli users create \ --username example_user \ --email example_user@linode.com \ --restricted true ``` Learn more... - __OAuth scopes__. ``` account:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/post-user operationId: post-user requestBody: content: application/json: schema: allOf: - additionalProperties: false description: A user on your account. Unrestricted users can log in and access information about your account, while restricted users may only access entities or perform actions they've been granted access to. properties: email: description: This user's email address. Akamai uses this address for account management communications. example: example_user@linode.com format: email type: string x-linode-cli-display: 2 last_login: additionalProperties: false description: __Read-only__ Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information. properties: login_datetime: description: __Read-only__ The date and time of this user's most recent login attempt. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: string status: description: __Read-only__ The result of this user's most recent login attempt. enum: - successful - failed example: successful readOnly: true type: string readOnly: true type: - object - 'null' password_created: description: __Read-only__ When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: - string - 'null' restricted: description: If `true`, this user needs specific access granted to perform actions or access entities on your account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted user. example: true type: boolean x-linode-cli-display: 3 ssh_keys: description: '__Read-only__ A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests: - [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance) - [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance) - [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)' example: - home-pc - laptop items: type: string readOnly: true type: array tfa_enabled: description: __Read-only__ Whether this user has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. example: true readOnly: true type: boolean username: description: __Filterable__ The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts. example: example_user maxLength: 32 minLength: 3 pattern: ^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$ type: string x-akamai: labels: - Filterable x-linode-cli-display: 1 x-linode-filterable: true verified_phone_number: description: __Read-only__ The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number. example: '+5555555555' format: phone readOnly: true type: - string - 'null' type: object x-akamai: file-path: schemas/user.yaml required: - username - email x-akamai: file-path: schemas/added-post-user.yaml x-example: x-ref: ../examples/post-user.json description: Information about the User to create. responses: '200': content: application/json: schema: additionalProperties: false description: A user on your account. Unrestricted users can log in and access information about your account, while restricted users may only access entities or perform actions they've been granted access to. properties: email: description: This user's email address. Akamai uses this address for account management communications. example: example_user@linode.com format: email type: string x-linode-cli-display: 2 last_login: additionalProperties: false description: __Read-only__ Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information. properties: login_datetime: description: __Read-only__ The date and time of this user's most recent login attempt. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: string status: description: __Read-only__ The result of this user's most recent login attempt. enum: - successful - failed example: successful readOnly: true type: string readOnly: true type: - object - 'null' password_created: description: __Read-only__ When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: - string - 'null' restricted: description: If `true`, this user needs specific access granted to perform actions or access entities on your account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted user. example: true type: boolean x-linode-cli-display: 3 ssh_keys: description: '__Read-only__ A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests: - [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance) - [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance) - [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)' example: - home-pc - laptop items: type: string readOnly: true type: array tfa_enabled: description: __Read-only__ Whether this user has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. example: true readOnly: true type: boolean username: description: __Filterable__ The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts. example: example_user maxLength: 32 minLength: 3 pattern: ^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$ type: string x-akamai: labels: - Filterable x-linode-cli-display: 1 x-linode-filterable: true verified_phone_number: description: __Read-only__ The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number. example: '+5555555555' format: phone readOnly: true type: - string - 'null' type: object x-akamai: file-path: schemas/user.yaml x-example: x-ref: ../examples/post-user-200.json description: New User created successfully. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - account:read_write summary: Create a user tags: - Users x-akamai: tabs: - syntax: "linode-cli users create \\\n --username example_user \\\n --email example_user@linode.com \\\n --restricted true" title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: account:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: create x-linode-grant: unrestricted only get: description: 'Returns a paginated list of all users on your account. > 📘 > > This operation can only be accessed by account users with _unrestricted_ access. Talk to your local account administrator about access management. A user can access all or part of an account based on their access status and grants: - __Unrestricted access__. These users can access everything on an account. - __Restricted access__. These users can only access entities or perform actions they''ve been given specific grants to. > --- - __CLI__. ``` linode-cli users list ``` Learn more... - __OAuth scopes__. ``` account:read_only ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-users operationId: get-users parameters: - description: The page of a collection to return. example: '{{page}}' in: query name: page required: false schema: default: 1 example: 6 minimum: 1 type: integer x-akamai: file-path: parameters/page-offset.yaml - description: The number of items to return per page. example: '{{page_size}}' in: query name: page_size schema: default: 100 example: 50 maximum: 500 minimum: 25 type: integer x-akamai: file-path: parameters/page-size.yaml responses: '200': content: application/json: example: data: - email: jperez@linode.com last_login: login_datetime: '2018-01-01T01:01:01' status: successful password_created: '2018-01-01T01:01:01' restricted: true ssh_keys: - home-pc - laptop tfa_enabled: true user_type: parent username: jsmith verified_phone_number: '+5555555555' page: 1 pages: 1 results: 1 schema: additionalProperties: false properties: data: items: allOf: - additionalProperties: false description: A user on your account. Unrestricted users can log in and access information about your account, while restricted users may only access entities or perform actions they've been granted access to. properties: email: description: This user's email address. Akamai uses this address for account management communications. example: example_user@linode.com format: email type: string x-linode-cli-display: 2 last_login: additionalProperties: false description: __Read-only__ Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information. properties: login_datetime: description: __Read-only__ The date and time of this user's most recent login attempt. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: string status: description: __Read-only__ The result of this user's most recent login attempt. enum: - successful - failed example: successful readOnly: true type: string readOnly: true type: - object - 'null' password_created: description: __Read-only__ When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: - string - 'null' restricted: description: If `true`, this user needs specific access granted to perform actions or access entities on your account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted user. example: true type: boolean x-linode-cli-display: 3 ssh_keys: description: '__Read-only__ A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests: - [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance) - [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance) - [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)' example: - home-pc - laptop items: type: string readOnly: true type: array tfa_enabled: description: __Read-only__ Whether this user has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. example: true readOnly: true type: boolean username: description: __Filterable__ The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts. example: example_user maxLength: 32 minLength: 3 pattern: ^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$ type: string x-akamai: labels: - Filterable x-linode-cli-display: 1 x-linode-filterable: true verified_phone_number: description: __Read-only__ The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number. example: '+5555555555' format: phone readOnly: true type: - string - 'null' type: object x-akamai: file-path: schemas/user.yaml - additionalProperties: false description: The type of user on an account. Mostly applies to the use of the parent and child accounts for Akamai partners functionality. properties: user_type: description: '__Read-only__ If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include: - `parent`. This is a user in an Akamai partner account. Akamai partners have a contractual relationship with their end customers, to sell Akamai services. This user can either have full access (a parent account admin user) or limited access. Limited users don''t have access to manage child accounts, but they can be granted this access by an admin user. - `child`. This is an Akamai partner''s end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account. - `proxy`. This is a user on a child account that gives parent account users access to that child account. A parent account user with the `child_account_access` grant can [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token) from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user. - `default`. This applies to all regular, non-parent-child account users.' enum: - parent - child - proxy - default example: parent readOnly: true type: string type: object x-akamai: file-path: schemas/user-type.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/added-get-users-200.yaml description: A paginated list of users. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - account:read_only summary: List users tags: - Users x-akamai: tabs: - syntax: linode-cli users list title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: account:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: - list - ls x-linode-grant: unrestricted only /{apiVersion}/account/users/{username}: parameters: - description: __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. example: '{{apiVersion}}' in: path name: apiVersion required: true schema: enum: - v4 - v4beta type: string x-akamai: file-path: parameters/api-version-path.yaml - description: The username to look up. example: '{{username}}' in: path name: username required: true schema: type: string x-akamai: file-path: parameters/username-path.yaml x-akamai: file-path: paths/username.yaml path-info: /{apiVersion}/account/users/{username} x-linode-cli-command: users get: description: 'Returns information about a single user on your account. > 📘 > > This operation can only be accessed by account users with _unrestricted_ access. Talk to your local account administrator about access management. > --- - __CLI__. ``` linode-cli users view example_user ``` Learn more... - __OAuth scopes__. ``` account:read_only ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-user operationId: get-user responses: '200': content: application/json: example: ref: ../examples/get-user-200.json schema: allOf: - additionalProperties: false description: A user on your account. Unrestricted users can log in and access information about your account, while restricted users may only access entities or perform actions they've been granted access to. properties: email: description: This user's email address. Akamai uses this address for account management communications. example: example_user@linode.com format: email type: string x-linode-cli-display: 2 last_login: additionalProperties: false description: __Read-only__ Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information. properties: login_datetime: description: __Read-only__ The date and time of this user's most recent login attempt. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: string status: description: __Read-only__ The result of this user's most recent login attempt. enum: - successful - failed example: successful readOnly: true type: string readOnly: true type: - object - 'null' password_created: description: __Read-only__ When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: - string - 'null' restricted: description: If `true`, this user needs specific access granted to perform actions or access entities on your account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted user. example: true type: boolean x-linode-cli-display: 3 ssh_keys: description: '__Read-only__ A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests: - [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance) - [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance) - [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)' example: - home-pc - laptop items: type: string readOnly: true type: array tfa_enabled: description: __Read-only__ Whether this user has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. example: true readOnly: true type: boolean username: description: __Filterable__ The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts. example: example_user maxLength: 32 minLength: 3 pattern: ^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$ type: string x-akamai: labels: - Filterable x-linode-cli-display: 1 x-linode-filterable: true verified_phone_number: description: __Read-only__ The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number. example: '+5555555555' format: phone readOnly: true type: - string - 'null' type: object x-akamai: file-path: schemas/user.yaml - additionalProperties: false description: The type of user on an account. Mostly applies to the use of the parent and child accounts for Akamai partners functionality. properties: user_type: description: '__Read-only__ If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include: - `parent`. This is a user in an Akamai partner account. Akamai partners have a contractual relationship with their end customers, to sell Akamai services. This user can either have full access (a parent account admin user) or limited access. Limited users don''t have access to manage child accounts, but they can be granted this access by an admin user. - `child`. This is an Akamai partner''s end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account. - `proxy`. This is a user on a child account that gives parent account users access to that child account. A parent account user with the `child_account_access` grant can [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token) from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user. - `default`. This applies to all regular, non-parent-child account users.' enum: - parent - child - proxy - default example: parent readOnly: true type: string type: object x-akamai: file-path: schemas/user-type.yaml x-akamai: file-path: schemas/added-get-user-200.yaml description: The requested User object. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - account:read_only summary: Get a user tags: - Users x-akamai: tabs: - syntax: linode-cli users view example_user title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: account:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: view x-linode-grant: unrestricted only put: description: 'Update information about a user on your account, including its restricted status. When setting a user to `restricted`, the API sets no grants for it. You need to set grants so that user can access things on the account. > 📘 > > This operation can only be accessed by account users with _unrestricted_ access. Talk to your local account administrator about access management. __Parent and child accounts__ In a parent and child account environment, the following apply: - You can''t edit the `username` or `email` values for the child account parent user (proxy user). These are predefined for the proxy user when you initially provision the parent-child relationship. Only a proxy user''s `restricted` status can be modified. This can only be done by an unrestricted child account user. - A parent account using an unrestricted proxy user in a child account can modify the `username`, `email`, and `restricted` status for an existing child account user. - A restricted account user--parent or child--can''t change their user to `unrestricted`. > --- - __CLI__. ``` linode-cli users update example_user \ --username example_user \ --email example@linode.com \ --restricted true ``` Learn more... - __OAuth scopes__. ``` account:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/put-user operationId: put-user requestBody: content: application/json: schema: additionalProperties: false description: A user on your account. Unrestricted users can log in and access information about your account, while restricted users may only access entities or perform actions they've been granted access to. properties: email: description: This user's email address. Akamai uses this address for account management communications. example: '{{email}}' format: email type: string x-linode-cli-display: 2 last_login: additionalProperties: false description: __Read-only__ Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information. properties: login_datetime: description: __Read-only__ The date and time of this user's most recent login attempt. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: string status: description: __Read-only__ The result of this user's most recent login attempt. enum: - successful - failed example: successful readOnly: true type: string readOnly: true type: - object - 'null' password_created: description: __Read-only__ When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set. example: '{{password_created}}' format: date-time readOnly: true type: - string - 'null' restricted: description: If `true`, this user needs specific access granted to perform actions or access entities on your account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted user. example: '{{restricted}}' type: boolean x-linode-cli-display: 3 ssh_keys: description: '__Read-only__ A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests: - [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance) - [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance) - [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)' example: - home-pc - laptop items: type: string readOnly: true type: array tfa_enabled: description: __Read-only__ Whether this user has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. example: '{{tfa_enabled}}' readOnly: true type: boolean username: description: __Filterable__ The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts. example: '{{username}}' maxLength: 32 minLength: 3 pattern: ^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$ type: string x-akamai: labels: - Filterable x-linode-cli-display: 1 x-linode-filterable: true verified_phone_number: description: __Read-only__ The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number. example: '{{verified_phone_number}}' format: phone readOnly: true type: - string - 'null' type: object x-akamai: file-path: schemas/user.yaml x-example: x-ref: ../examples/put-user.json description: The information to update. responses: '200': content: application/json: example: email: jkowalski@linode.com last_login: login_datetime: '2018-01-01T01:01:01' status: successful password_created: '2018-01-01T01:01:01' restricted: true ssh_keys: - home-pc - laptop tfa_enabled: true user_type: parent username: adevi verified_phone_number: '+5555555555' schema: allOf: - additionalProperties: false description: A user on your account. Unrestricted users can log in and access information about your account, while restricted users may only access entities or perform actions they've been granted access to. properties: email: description: This user's email address. Akamai uses this address for account management communications. example: example_user@linode.com format: email type: string x-linode-cli-display: 2 last_login: additionalProperties: false description: __Read-only__ Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information. properties: login_datetime: description: __Read-only__ The date and time of this user's most recent login attempt. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: string status: description: __Read-only__ The result of this user's most recent login attempt. enum: - successful - failed example: successful readOnly: true type: string readOnly: true type: - object - 'null' password_created: description: __Read-only__ When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: - string - 'null' restricted: description: If `true`, this user needs specific access granted to perform actions or access entities on your account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted user. example: true type: boolean x-linode-cli-display: 3 ssh_keys: description: '__Read-only__ A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests: - [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance) - [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance) - [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)' example: - home-pc - laptop items: type: string readOnly: true type: array tfa_enabled: description: __Read-only__ Whether this user has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. example: true readOnly: true type: boolean username: description: __Filterable__ The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts. example: example_user maxLength: 32 minLength: 3 pattern: ^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$ type: string x-akamai: labels: - Filterable x-linode-cli-display: 1 x-linode-filterable: true verified_phone_number: description: __Read-only__ The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number. example: '+5555555555' format: phone readOnly: true type: - string - 'null' type: object x-akamai: file-path: schemas/user.yaml - additionalProperties: false description: The type of user on an account. Mostly applies to the use of the parent and child accounts for Akamai partners functionality. properties: user_type: description: '__Read-only__ If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include: - `parent`. This is a user in an Akamai partner account. Akamai partners have a contractual relationship with their end customers, to sell Akamai services. This user can either have full access (a parent account admin user) or limited access. Limited users don''t have access to manage child accounts, but they can be granted this access by an admin user. - `child`. This is an Akamai partner''s end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account. - `proxy`. This is a user on a child account that gives parent account users access to that child account. A parent account user with the `child_account_access` grant can [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token) from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user. - `default`. This applies to all regular, non-parent-child account users.' enum: - parent - child - proxy - default example: parent readOnly: true type: string type: object x-akamai: file-path: schemas/user-type.yaml x-akamai: file-path: schemas/added-put-user-200.yaml description: User updated successfully. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - account:read_write summary: Update a user tags: - Users x-akamai: tabs: - syntax: "linode-cli users update example_user \\\n --username example_user \\\n --email example@linode.com \\\n --restricted true" title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: account:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: update x-linode-grant: unrestricted only delete: description: 'Deletes a user. The API immediately logs the user out and removes all of its `grants`. > 📘 > > This operation can only be accessed by account users with _unrestricted_ access. Talk to your local account administrator about access management. __Parent and child accounts__ In a parent and child account environment, the following apply: - You can''t delete a child account parent user (proxy user). The API returns a 403 error if you target a proxy user with this operation. - A parent account using an unrestricted proxy user can use this operation to delete a child account user. > --- - __CLI__. ``` linode-cli users delete example_user ``` Learn more... - __OAuth scopes__. ``` account:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/delete-user operationId: delete-user responses: '200': content: application/json: schema: description: The API responds with an empty object. maxProperties: 0 type: object x-akamai: file-path: schemas/added-empty-obj.yaml x-example: x-ref: ../examples/delete-user-200.json description: User deleted successfully. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - account:read_write summary: Delete a user tags: - Users x-akamai: tabs: - syntax: linode-cli users delete example_user title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: account:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: - delete - rm x-linode-grant: unrestricted only /{apiVersion}/account/users/{username}/grants: parameters: - description: __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. example: '{{apiVersion}}' in: path name: apiVersion required: true schema: enum: - v4 - v4beta type: string x-akamai: file-path: parameters/api-version-path.yaml - description: The username to look up. example: '{{username}}' in: path name: username required: true schema: type: string x-akamai: file-path: parameters/username-path.yaml x-akamai: file-path: paths/account-grants.yaml path-info: /{apiVersion}/account/users/{username}/grants x-linode-cli-command: users get: description: 'Returns the full grants structure for an account username you specify. This includes all entities on the account, and the level of access this user has to each of them. This doesn''t apply to the account owner or the current authenticated user. You can run the List grants operation to view those grants. However, this doesn''t show the entities that they _don''t_ have access to. > 📘 > > This operation can only be accessed by account users with _unrestricted_ access. Talk to your local account administrator about access management. > --- - __OAuth scopes__. ``` account:read_only ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-user-grants operationId: get-user-grants responses: '200': content: application/json: schema: additionalProperties: false properties: database: description: The grants this user has for individual Managed Databases on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array domain: description: The grants this user has for individual domains on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array firewall: description: The grants this user has for individual firewalls on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array global: additionalProperties: false description: The grants the user has to all resources on your account. properties: account_access: description: 'The level of access this user has to account-level actions, like billing information and user management. > 📘 > > A `restricted` user can''t be used to manage users, even if this is set to `read-write`. Only unrestricted users can manage other users on an account. __Parent and child accounts__ In a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, this grant can be added to a child account user, to give the user `read-write` access. This gives the child user unrestricted access to expected management operations, such as creating other child users. However, child users don''t have write access to billing operations. The API issues a specific error message if a write operation is attempted by a child user.' enum: - read_only - read_write example: read_only type: - string - 'null' add_databases: description: Whether this user can add Managed Databases on the account. example: true type: boolean add_domains: description: Whether this user can add domains on the account. example: true type: boolean add_firewalls: description: Whether this user can add Firewalls on the account. example: true type: boolean add_images: description: Whether this user can create images from disks on your Linodes, on the account. example: true type: boolean add_linodes: description: Whether this user can create Linodes. example: true type: boolean add_longview: description: Whether this user can create Longview clients and view the current plan. example: true type: boolean add_nodebalancers: description: Whether this user can add NodeBalancers on the account. example: true type: boolean add_stackscripts: description: Whether this user can add StackScripts on the account. example: true type: boolean add_volumes: description: Whether this user can add volumes on the account. example: true type: boolean add_vpcs: description: Whether this user can add Virtual Private Clouds (VPCs) on the account. example: true type: boolean cancel_account: description: Whether this user can cancel the entire account. example: false type: boolean child_account_access: description: In a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, this gives a parent account access to operations that can be used to manage child accounts. Unrestricted parent account users have access to this grant, while restricted parent users don't. An unrestricted parent user can set this to `true` to add this grant to a restricted parent user. Displayed as `null` for all non-parent accounts. example: true type: - boolean - 'null' longview_subscription: description: Whether this user can manage your account's Longview subscription. example: true type: boolean type: object image: description: The grants this user has for individual images on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array linode: description: The grants this user has for individual Linodes on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array longview: description: The grants this user has for individual Longview Clients on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array nodebalancer: description: The grants this user has for individual NodeBalancers on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array stackscript: description: The grants this User has for individual StackScripts on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array volume: description: The grants this user has individual Block Storage Volumes on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array vpc: description: The grants this user has individual Virtual Private Clouds (VPCs) on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array type: object x-akamai: file-path: schemas/grants-response.yaml x-example: x-ref: ../examples/get-user-grants-200.json description: The User's grants. '204': content: {} description: This is an unrestricted user. These users don't use grants. They can access everything on the account and perform all actions. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - account:read_only summary: List a user's grants tags: - Users x-akamai: tabs: - syntax: account:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: grants x-linode-cli-skip: true x-linode-grant: unrestricted only put: description: 'Update the grants for a restricted user. This can be used to give a user access to new entities or actions, or take access away. Omit a grant object from the request to keep its current setting. > 📘 > > - This operation can only be accessed by account users with _unrestricted_ access. Talk to your local account administrator about access management. > > - This operation only applies to _restricted_ users. An unrestricted user has access to everything and doesn''t use grants. __Parent and child accounts__ In a parent and child account environment, the following apply: - No child account user can modify the `account_access` grant for the child account parent user (proxy user). - An unrestricted child account user can configure all other grants for the proxy user, with the `global` object. - An unrestricted child account user can enable the `account_access` grant for other child account users. However, enabled child users are still subject to child user restrictions--they can''t perform write operations for any billing or account information. > --- - __OAuth scopes__. ``` account:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/put-user-grants operationId: put-user-grants requestBody: content: application/json: schema: additionalProperties: false properties: database: description: The grants this user has for individual Managed Databases on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array domain: description: The grants this user has for individual domains on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array firewall: description: The grants this user has for individual firewalls on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array global: additionalProperties: false description: The grants the user has to all resources on your account. properties: account_access: description: 'The level of access this user has to account-level actions, like billing information and user management. > 📘 > > A `restricted` user can''t be used to manage users, even if this is set to `read-write`. Only unrestricted users can manage other users on an account. __Parent and child accounts__ In a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, this grant can be added to a child account user, to give the user `read-write` access. This gives the child user unrestricted access to expected management operations, such as creating other child users. However, child users don''t have write access to billing operations. The API issues a specific error message if a write operation is attempted by a child user.' enum: - read_only - read_write example: read_only type: - string - 'null' add_databases: description: Whether this user can add Managed Databases on the account. example: true type: boolean add_domains: description: Whether this user can add domains on the account. example: true type: boolean add_firewalls: description: Whether this user can add Firewalls on the account. example: true type: boolean add_images: description: Whether this user can create images from disks on your Linodes, on the account. example: true type: boolean add_linodes: description: Whether this user can create Linodes. example: true type: boolean add_longview: description: Whether this user can create Longview clients and view the current plan. example: true type: boolean add_nodebalancers: description: Whether this user can add NodeBalancers on the account. example: true type: boolean add_stackscripts: description: Whether this user can add StackScripts on the account. example: true type: boolean add_volumes: description: Whether this user can add volumes on the account. example: true type: boolean add_vpcs: description: Whether this user can add Virtual Private Clouds (VPCs) on the account. example: true type: boolean cancel_account: description: Whether this user can cancel the entire account. example: false type: boolean child_account_access: description: In a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, this gives a parent account access to operations that can be used to manage child accounts. Unrestricted parent account users have access to this grant, while restricted parent users don't. An unrestricted parent user can set this to `true` to add this grant to a restricted parent user. Displayed as `null` for all non-parent accounts. example: true type: - boolean - 'null' longview_subscription: description: Whether this user can manage your account's Longview subscription. example: true type: boolean type: object image: description: The grants this user has for individual images on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array linode: description: The grants this user has for individual Linodes on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array longview: description: The grants this user has for individual Longview Clients on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array nodebalancer: description: The grants this user has for individual NodeBalancers on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array stackscript: description: The grants this User has for individual StackScripts on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array volume: description: The grants this user has individual Block Storage Volumes on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array vpc: description: The grants this user has individual Virtual Private Clouds (VPCs) on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array type: object x-akamai: file-path: schemas/grants-response.yaml x-example: x-ref: ../examples/put-user-grants.json required: true responses: '200': content: application/json: schema: additionalProperties: false properties: database: description: The grants this user has for individual Managed Databases on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array domain: description: The grants this user has for individual domains on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array firewall: description: The grants this user has for individual firewalls on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array global: additionalProperties: false description: The grants the user has to all resources on your account. properties: account_access: description: 'The level of access this user has to account-level actions, like billing information and user management. > 📘 > > A `restricted` user can''t be used to manage users, even if this is set to `read-write`. Only unrestricted users can manage other users on an account. __Parent and child accounts__ In a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, this grant can be added to a child account user, to give the user `read-write` access. This gives the child user unrestricted access to expected management operations, such as creating other child users. However, child users don''t have write access to billing operations. The API issues a specific error message if a write operation is attempted by a child user.' enum: - read_only - read_write example: read_only type: - string - 'null' add_databases: description: Whether this user can add Managed Databases on the account. example: true type: boolean add_domains: description: Whether this user can add domains on the account. example: true type: boolean add_firewalls: description: Whether this user can add Firewalls on the account. example: true type: boolean add_images: description: Whether this user can create images from disks on your Linodes, on the account. example: true type: boolean add_linodes: description: Whether this user can create Linodes. example: true type: boolean add_longview: description: Whether this user can create Longview clients and view the current plan. example: true type: boolean add_nodebalancers: description: Whether this user can add NodeBalancers on the account. example: true type: boolean add_stackscripts: description: Whether this user can add StackScripts on the account. example: true type: boolean add_volumes: description: Whether this user can add volumes on the account. example: true type: boolean add_vpcs: description: Whether this user can add Virtual Private Clouds (VPCs) on the account. example: true type: boolean cancel_account: description: Whether this user can cancel the entire account. example: false type: boolean child_account_access: description: In a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, this gives a parent account access to operations that can be used to manage child accounts. Unrestricted parent account users have access to this grant, while restricted parent users don't. An unrestricted parent user can set this to `true` to add this grant to a restricted parent user. Displayed as `null` for all non-parent accounts. example: true type: - boolean - 'null' longview_subscription: description: Whether this user can manage your account's Longview subscription. example: true type: boolean type: object image: description: The grants this user has for individual images on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array linode: description: The grants this user has for individual Linodes on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array longview: description: The grants this user has for individual Longview Clients on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array nodebalancer: description: The grants this user has for individual NodeBalancers on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array stackscript: description: The grants this User has for individual StackScripts on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array volume: description: The grants this user has individual Block Storage Volumes on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array vpc: description: The grants this user has individual Virtual Private Clouds (VPCs) on this account. items: additionalProperties: false description: Represents the level of access a restricted user has to a specific resource on the account. properties: id: description: The unique identifier of the resource this grant applies to. example: 123 type: integer label: description: __Read-only__ The name of the entity this grant applies to. This is only for display purposes. example: example-entity readOnly: true type: string permissions: description: The level of access this user has to this entity. If `null`, this user has no access. enum: - read_only - read_write example: read_only type: - string - 'null' type: object x-akamai: file-path: schemas/grant.yaml type: array type: object x-akamai: file-path: schemas/grants-response.yaml x-example: x-ref: ../examples/get-user-grants-200.json description: Grants updated successfully. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - account:read_write summary: Update a user's grants tags: - Users x-akamai: tabs: - syntax: account:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: update-grants x-linode-cli-skip: true x-linode-grant: unrestricted only components: securitySchemes: oauth: flows: authorizationCode: authorizationUrl: https://login.linode.com/oauth/authorize scopes: account:read_only: Allows access to GET information about your account. account:read_write: Allows access to all endpoints related to your account. domains:read_only: Allows access to GET Domains on your account. domains:read_write: Allows access to all Domain endpoints. events:read_only: Allows access to GET your Events. events:read_write: Allows access to all endpoints related to your Events. firewall:read_only: Allows access to GET information about your Firewalls. firewall:read_write: Allows access to all Firewall endpoints. images:read_only: Allows access to GET your Images. images:read_write: Allows access to all endpoints related to your Images. ips:read_only: Allows access to GET your ips. ips:read_write: Allows access to all endpoints related to your ips. linodes:read_only: Allows access to GET Linodes on your account. linodes:read_write: Allow access to all endpoints related to your Linodes. lke:read_only: Allows access to GET LKE Clusters on your account. lke:read_write: Allows access to all endpoints related to LKE Clusters on your account. longview:read_only: Allows access to GET your Longview Clients. longview:read_write: Allows access to all endpoints related to your Longview Clients. monitor:read-write: Allows access to all Monitor (Akamai Cloud Pulse) endpoints. monitor:read_only: Allows access to Monitor (Akamai Cloud Pulse) data. nodebalancers:read_only: Allows access to GET NodeBalancers on your account. nodebalancers:read_write: Allows access to all NodeBalancer endpoints. object_storage:read_only: Allows access to GET information related to your Object Storage. object_storage:read_write: Allows access to all Object Storage endpoints. stackscripts:read_only: Allows access to GET your StackScripts. stackscripts:read_write: Allows access to all endpoints related to your StackScripts. volumes:read_only: Allows access to GET your Volumes. volumes:read_write: Allows access to all endpoints related to your Volumes. vpc:read_write: Allows access to all endpoints related to VPC and Subnet creation, updating, and deletion. tokenUrl: https://login.linode.com/oauth/token type: oauth2 personalAccessToken: scheme: bearer type: http externalDocs: description: See documentation for Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference x-readme: samples-languages: - curl - python - node