child_accounts

Creates, updates, deletes, gets or lists a child_accounts resource.

Overview

Name	child_accounts
Type	Resource
Id	linode.account.child_accounts

Fields

The following fields are returned by SELECT queries:

get_child_account

Returns the child-level account for a specified euuid.

Name	Datatype	Description
tax_id	string	The tax identification number for this child account. Use this for tax calculations in some countries. If you live in a country that doesn't collect taxes, ensure this is an empty string (""). (example: ATU99999999)
first_name	string	Filterable The first name of the owner of this child account. It can't include any of these characters: < > ( ) " =. (example: John)
last_name	string	Filterable The last name of the owner of this child account. It can't include any of these characters: < > ( ) " =. (example: Smith)
active_since	string (date-time)	Read-only The activation date and time for the child account. (example: 2018-01-01T00:01:01)
address_1	string	Filterable First line of this child account's billing address. (example: 123 Main Street)
address_2	string	Filterable Second line of this child account's billing address, if applicable. (example: Suite A)
balance	number	Read-only This child account's balance, in US dollars.
balance_uninvoiced	number	Read-only This child account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.
billing_source	string	Read-only The source of service charges for this account, as determined by its relationship with Akamai. The API returns a value of external to describe a child account in a parent-child account environment. (example: external)
capabilities	array	Read-only A list of the capabilities the child account supports.
city	string	Filterable The city for this child account's billing address. (example: San Diego)
company	string	Filterable The company name for the owner of this child account. It can't include any of these characters: < > ( ) " =. You can't change this value yourself. We use it to create the proxy users that a parent account uses to access a child account. Talk to your account team if you need to change this value. (example: Acme)
country	string	Filterable The two-letter ISO 3166 country code for this child account's billing address. (example: US)
credit_card	object	Read-only Information for the credit card you've assigned to this child account.
email	string	Filterable The email address of the owner of this child account. (example: john.smith@linode.com)
euuid	string (uuid)	Read-only An external, unique identifier that Akamai assigned to the child account. (example: A1BC2DEF-34GH-567I-J890KLMN12O34P56)
phone	string	Filterable The phone number for the owner of this child account. (example: 858-555-1212)
state	string	Filterable The state or province for the billing address (address_1 and address_2, if applicable). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code. > 📘 > > If this is a US military address, use state abbreviations (AA, AE, AP). (example: CA)
zip	string	Filterable The zip code of this Account's billing address. The following restrictions apply: - Can only contain ASCII letters, numbers, and hyphens (-). - Can't contain more than 9 letter or number characters. (example: 92111-1234)

get_child_accounts

Returns child-level accounts.

Name	Datatype	Description
data	array
page	integer	Read-only The current page.
pages	integer	Read-only The total number of pages.
results	integer	Read-only The total number of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_child_account	select			View a specific child account based on its euuid. See Parent and Child Accounts for Akamai Partners for details on these accounts. > 📘 > > This operation can only be accessed by an unrestricted user, or restricted user with the child_account_access grant. Learn more... Learn more...
get_child_accounts	select		page, page_size	Returns a paginated list of basic information for the child accounts that exist for your parent account. See Parent and Child Accounts for Akamai Partners for details on these accounts. > 📘 > > This operation can only be accessed by an unrestricted parent user, or restricted parent user with the child_account_access grant. Learn more... Learn more...
post_child_account_token	exec			Create a short-lived bearer token for a parent user on a child account, using the euuid of that child account. In the context of the API, a parent user on a child account is referred to as a "proxy user." When Akamai provisions your parent-child account environment, a proxy user is automatically set in the child account. It follows a specific naming convention: <Parent account company name>_<SHA256 hash of parent company name and child account euuid> > 📘 > > These variables only use the first 15 and 16 characters of these values, respectively. The token lets a parent account run API operations through the proxy user, as if they are a child user in the child account. These points apply to the use of this operation: - To create a token, a parent account user needs the child_account_access grant. This lets them use the proxy user on the child account. You can run List a user's grants on a parent account user to check its child_account_access setting. To add this access, you can update the parent account user. - The created token inherits the permissions of the proxy user. It will never have less. - The API returns the raw token in the response. You can't get it again, so be sure to store it. Example workflow: 1. List child accounts and store the euuid for the applicable one. 2. Run this operation and store the token that's created for the proxy user. 3. As a parent account user with access to the proxy user in the child account, use this token to authenticate API operations, as if you were a child user. Learn more... Learn more...

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
page	integer	The page of a collection to return.
page_size	integer	The number of items to return per page.

SELECT examples

get_child_account

View a specific child account based on its euuid. See Parent and Child Accounts for Akamai Partners for details on these accounts.

> 📘
>
> This operation can only be accessed by an unrestricted user, or restricted user with the child_account_access grant.

Learn more...

Learn more...

SELECT
tax_id,
first_name,
last_name,
active_since,
address_1,
address_2,
balance,
balance_uninvoiced,
billing_source,
capabilities,
city,
company,
country,
credit_card,
email,
euuid,
phone,
state,
zip
FROM linode.account.child_accounts;

get_child_accounts

Returns a paginated list of basic information for the child accounts that exist for your parent account. See Parent and Child Accounts for Akamai Partners for details on these accounts.

> 📘
>
> This operation can only be accessed by an unrestricted parent user, or restricted parent user with the child_account_access grant.

Learn more...

Learn more...

SELECT
data,
page,
pages,
results
FROM linode.account.child_accounts
WHERE page = '{{ page }}'
AND page_size = '{{ page_size }}';

Lifecycle Methods

post_child_account_token

Create a short-lived bearer token for a parent user on a child account, using the euuid of that child account. In the context of the API, a parent user on a child account is referred to as a "proxy user." When Akamai provisions your parent-child account environment, a proxy user is automatically set in the child account. It follows a specific naming convention:

<Parent account company name>_<SHA256 hash of parent company name and child account euuid>

> 📘
>
> These variables only use the first 15 and 16 characters of these values, respectively.

The token lets a parent account run API operations through the proxy user, as if they are a child user in the child account.

These points apply to the use of this operation:

- To create a token, a parent account user needs the child_account_access grant. This lets them use the proxy user on the child account. You can run List a user's grants on a parent account user to check its child_account_access setting. To add this access, you can update the parent account user.

- The created token inherits the permissions of the proxy user. It will never have less.

- The API returns the raw token in the response. You can't get it again, so be sure to store it.

Example workflow:

1. List child accounts and store the euuid for the applicable one.
2. Run this operation and store the token that's created for the proxy user.
3. As a parent account user with access to the proxy user in the child account, use this token to authenticate API operations, as if you were a child user.

Learn more...

Learn more...

EXEC linode.account.child_accounts.post_child_account_token 
;