Account
User's Grants View
https://api.linode.com/v4/account/users/{username}/grantsReturns 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.
Path Parameters
The username to look up.
Request Samples
- Shell
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/account/users/example_user/grants
Response Samples
- 200
- 204
- default
{
"global": {
"add_linodes": true,
"add_longview": true,
"longview_subscription": true,
"account_access": "read_only",
"cancel_account": false,
"add_domains": true,
"add_stackscripts": true,
"add_nodebalancers": true,
"add_images": true,
"add_volumes": true,
"add_firewalls": true,
"add_databases": true
},
"linode": [
{
"id": 123,
"permissions": "read_only",
"label": "example-entity"
}
],
"database": [
{
"id": 123,
"permissions": "read_only",
"label": "example-entity"
}
],
"domain": [
{
"id": 123,
"permissions": "read_only",
"label": "example-entity"
}
],
"nodebalancer": [
{
"id": 123,
"permissions": "read_only",
"label": "example-entity"
}
],
"image": [
{
"id": 123,
"permissions": "read_only",
"label": "example-entity"
}
],
"longview": [
{
"id": 123,
"permissions": "read_only",
"label": "example-entity"
}
],
"stackscript": [
{
"id": 123,
"permissions": "read_only",
"label": "example-entity"
}
],
"volume": [
{
"id": 123,
"permissions": "read_only",
"label": "example-entity"
}
]
}Responses
200: The User's grants.
A structure containing the Account-level grants a User has.
If true, this User may create Linodes.
If true, this User may create Longview clients and view the current plan.
If true, this User may manage the Account's Longview subscription.
The level of access this User has to Account-level actions, like billing information. A restricted User will never be able to manage users.
If true, this User may cancel the entire Account.
If true, this User may add Domains.
If true, this User may add StackScripts.
If true, this User may add NodeBalancers.
If true, this User may add Images.
If true, this User may add Volumes.
If true, this User may add Firewalls.
if true, this User may add Managed Databases.
The grants this User has for each Linode that is owned by this Account.
The ID of the entity this grant applies to.
The level of access this User has to this entity. If null, this User has no access.
The current label of the entity this grant applies to, for display purposes.
The grants this User has for each Database that is owned by this Account.
The ID of the entity this grant applies to.
The level of access this User has to this entity. If null, this User has no access.
The current label of the entity this grant applies to, for display purposes.
The grants this User has for each Domain that is owned by this Account.
The ID of the entity this grant applies to.
The level of access this User has to this entity. If null, this User has no access.
The current label of the entity this grant applies to, for display purposes.
The grants this User has for each NodeBalancer that is owned by this Account.
The ID of the entity this grant applies to.
The level of access this User has to this entity. If null, this User has no access.
The current label of the entity this grant applies to, for display purposes.
The grants this User has for each Image that is owned by this Account.
The ID of the entity this grant applies to.
The level of access this User has to this entity. If null, this User has no access.
The current label of the entity this grant applies to, for display purposes.
The grants this User has for each Longview Client that is owned by this Account.
The ID of the entity this grant applies to.
The level of access this User has to this entity. If null, this User has no access.
The current label of the entity this grant applies to, for display purposes.
The grants this User has for each StackScript that is owned by this Account.
The ID of the entity this grant applies to.
The level of access this User has to this entity. If null, this User has no access.
The current label of the entity this grant applies to, for display purposes.
The grants this User has for each Block Storage Volume that is owned by this Account.
The ID of the entity this grant applies to.
The level of access this User has to this entity. If null, this User has no access.
The current label of the entity this grant applies to, for display purposes.
204: This is an unrestricted User, and therefore has no grants to return. This User may access everything on the Account and perform all actions.
default: Error
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 or perform some other action before you can complete the request successfully.
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.
User's Grants Update
https://api.linode.com/v4/account/users/{username}/grantsUpdate 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.
Path Parameters
The username to look up.
Request Body Schema
The grants this User has for each Database that is owned by this Account.
The grants this User has for each Domain that is owned by this Account.
A structure containing the Account-level grants a User has.
If true, this User may create Linodes.
If true, this User may create Longview clients and view the current plan.
If true, this User may manage the Account's Longview subscription.
The level of access this User has to Account-level actions, like billing information. A restricted User will never be able to manage users.
If true, this User may cancel the entire Account.
If true, this User may add Domains.
If true, this User may add StackScripts.
If true, this User may add NodeBalancers.
If true, this User may add Images.
If true, this User may add Volumes.
If true, this User may add Firewalls.
if true, this User may add Managed Databases.
The grants this User has for each Image that is owned by this Account.
The grants this User has for each Linode that is owned by this Account.
The grants this User has for each Longview Client that is owned by this Account.
The grants this User has for each NodeBalancer that is owned by this Account.
The grants this User has for each StackScript that is owned by this Account.
The grants this User has for each Block Storage Volume that is owned by this Account.
Request Samples
- Shell
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X PUT -d '{
"global": {
"add_linodes": true,
"add_nodebalancers": false,
"add_databases": true;
"add_domains": true,
"add_longview": false,
"add_stackscripts": true,
"longview_subscription": true,
"add_images": true,
"add_volumes": true,
"add_firewalls": true,
"account_access": "read_only",
"cancel_account": false
},
"domain": [
{
"id": 123,
"permissions": "read_only"
}
],
"image": [
{
"id": 123,
"permissions": "read_only"
}
],
"linode": [
{
"id": 123,
"permissions": "read_only"
},
{
"id": 234,
"permissions": "read_write"
},
{
"id": 345,
"permissions": "read_only"
},
],
"longview": [
{
"id": 123,
"permissions": "read_only"
},
{
"id": 234,
"permissions": "read_write"
}
],
"nodebalancer": [
{
"id": 123,
"permissions": "read_write"
}
],
"stackscript": [
{
"id": 123,
"permissions": "read_only"
},
{
"id": 124,
"permissions": "read_write"
}
],
"volume": [
{
"id": 123,
"permissions": "read_only"
}
]
}' \
https://api.linode.com/v4/account/users/example_user/grants
Response Samples
- 200
- default
{
"global": {
"add_linodes": true,
"add_longview": true,
"longview_subscription": true,
"account_access": "read_only",
"cancel_account": false,
"add_domains": true,
"add_stackscripts": true,
"add_nodebalancers": true,
"add_images": true,
"add_volumes": true,
"add_firewalls": true,
"add_databases": true
},
"linode": [
{
"id": 123,
"permissions": "read_only",
"label": "example-entity"
}
],
"database": [
{
"id": 123,
"permissions": "read_only",
"label": "example-entity"
}
],
"domain": [
{
"id": 123,
"permissions": "read_only",
"label": "example-entity"
}
],
"nodebalancer": [
{
"id": 123,
"permissions": "read_only",
"label": "example-entity"
}
],
"image": [
{
"id": 123,
"permissions": "read_only",
"label": "example-entity"
}
],
"longview": [
{
"id": 123,
"permissions": "read_only",
"label": "example-entity"
}
],
"stackscript": [
{
"id": 123,
"permissions": "read_only",
"label": "example-entity"
}
],
"volume": [
{
"id": 123,
"permissions": "read_only",
"label": "example-entity"
}
]
}Responses
200: Grants updated successfully.
A structure containing the Account-level grants a User has.
If true, this User may create Linodes.
If true, this User may create Longview clients and view the current plan.
If true, this User may manage the Account's Longview subscription.
The level of access this User has to Account-level actions, like billing information. A restricted User will never be able to manage users.
If true, this User may cancel the entire Account.
If true, this User may add Domains.
If true, this User may add StackScripts.
If true, this User may add NodeBalancers.
If true, this User may add Images.
If true, this User may add Volumes.
If true, this User may add Firewalls.
if true, this User may add Managed Databases.
The grants this User has for each Linode that is owned by this Account.
The ID of the entity this grant applies to.
The level of access this User has to this entity. If null, this User has no access.
The current label of the entity this grant applies to, for display purposes.
The grants this User has for each Database that is owned by this Account.
The ID of the entity this grant applies to.
The level of access this User has to this entity. If null, this User has no access.
The current label of the entity this grant applies to, for display purposes.
The grants this User has for each Domain that is owned by this Account.
The ID of the entity this grant applies to.
The level of access this User has to this entity. If null, this User has no access.
The current label of the entity this grant applies to, for display purposes.
The grants this User has for each NodeBalancer that is owned by this Account.
The ID of the entity this grant applies to.
The level of access this User has to this entity. If null, this User has no access.
The current label of the entity this grant applies to, for display purposes.
The grants this User has for each Image that is owned by this Account.
The ID of the entity this grant applies to.
The level of access this User has to this entity. If null, this User has no access.
The current label of the entity this grant applies to, for display purposes.
The grants this User has for each Longview Client that is owned by this Account.
The ID of the entity this grant applies to.
The level of access this User has to this entity. If null, this User has no access.
The current label of the entity this grant applies to, for display purposes.
The grants this User has for each StackScript that is owned by this Account.
The ID of the entity this grant applies to.
The level of access this User has to this entity. If null, this User has no access.
The current label of the entity this grant applies to, for display purposes.
The grants this User has for each Block Storage Volume that is owned by this Account.
The ID of the entity this grant applies to.
The level of access this User has to this entity. If null, this User has no access.
The current label of the entity this grant applies to, for display purposes.
default: Error
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 or perform some other action before you can complete the request successfully.
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.