Child Account ============= This section details Child Account-related Linode CLI commands. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-has-keywords .. _commands_child-account_list: `list `_ ----------------------------------------------------------------------------- .. rst-class:: action-keyword :action-keyword-key:`Aliases:` :action-keyword-values:`ls` Returns a paginated list of basic information for the child accounts that exist for your parent account. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli child-account list [-h] [--zip zip] [--address_2 address_2] [--first_name first_name] [--city city] [--state state] [--address_1 address_1] [--country country] [--last_name last_name] [--email email] [--phone phone] [--company company] [--order-by {zip,address_2,first_name,city,state,address_1,country,last_name,email,phone,company}] [--order {asc,desc}] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli child-account list .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Filterable Attributes .. rst-class:: action-subheading-description Arguments used to define a filter for response entries. .. rst-class:: action-filterable-field-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`\-\-address_1` - :action-table-field-type:`str` - First line of this child account's billing address. * - :action-table-field-name:`\-\-address_2` - :action-table-field-type:`str` - Second line of this child account's billing address, if applicable. * - :action-table-field-name:`\-\-city` - :action-table-field-type:`str` - The city for this child account's billing address. * - :action-table-field-name:`\-\-company` - :action-table-field-type:`str` - The company name for the owner of this child account. * - :action-table-field-name:`\-\-country` - :action-table-field-type:`str` - The two-letter ISO 3166 country code for this child account's billing address. * - :action-table-field-name:`\-\-email` - :action-table-field-type:`str` - The email address of the owner of this child account. * - :action-table-field-name:`\-\-first_name` - :action-table-field-type:`str` - The first name of the owner of this child account. * - :action-table-field-name:`\-\-last_name` - :action-table-field-type:`str` - The last name of the owner of this child account. * - :action-table-field-name:`\-\-phone` - :action-table-field-type:`str` - The phone number for the owner of this child account. * - :action-table-field-name:`\-\-state` - :action-table-field-type:`str` - The state or province for the billing address (``address_1`` and `address_2, if applicable`). * - :action-table-field-name:`\-\-zip` - :action-table-field-type:`str` - The zip code of this Account's billing address. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`active_since` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - The activation date and time for the child account. * - :action-table-field-name:`address_1` - :action-table-field-type:`str` - :action-table-field-example:`123 Main Street` - First line of this child account's billing address. * - :action-table-field-name:`address_2` - :action-table-field-type:`str` - :action-table-field-example:`Suite A` - Second line of this child account's billing address, if applicable. * - :action-table-field-name:`balance` - :action-table-field-type:`float` - :action-table-field-example:`200` - This child account's balance, in US dollars. * - :action-table-field-name:`balance_uninvoiced` - :action-table-field-type:`float` - :action-table-field-example:`145` - This child account's current estimated invoice in US dollars. * - :action-table-field-name:`billing_source` - :action-table-field-type:`str` - :action-table-field-example:`external` - The source of service charges for this account, as determined by its relationship with Akamai. * - :action-table-field-name:`capabilities` - :action-table-field-type:`[]str` - :action-table-field-example:`["Linodes", "...ct Storage"]` - A list of the capabilities the child account supports. * - :action-table-field-name:`city` - :action-table-field-type:`str` - :action-table-field-example:`San Diego` - The city for this child account's billing address. * - :action-table-field-name:`company` - :action-table-field-type:`str` - :action-table-field-example:`Acme` - The company name for the owner of this child account. * - :action-table-field-name:`country` - :action-table-field-type:`str` - :action-table-field-example:`US` - The two-letter ISO 3166 country code for this child account's billing address. * - :action-table-field-name:`email` - :action-table-field-type:`str` - :action-table-field-example:`john.smith@linode.com` - The email address of the owner of this child account. * - :action-table-field-name:`euuid` - :action-table-field-type:`str` - :action-table-field-example:`A1BC2DEF-34GH...KLMN12O34P56` - An external, unique identifier that Akamai assigned to the child account. * - :action-table-field-name:`first_name` - :action-table-field-type:`str` - :action-table-field-example:`John` - The first name of the owner of this child account. * - :action-table-field-name:`last_name` - :action-table-field-type:`str` - :action-table-field-example:`Smith` - The last name of the owner of this child account. * - :action-table-field-name:`phone` - :action-table-field-type:`str` - :action-table-field-example:`858-555-1212` - The phone number for the owner of this child account. * - :action-table-field-name:`state` - :action-table-field-type:`str` - :action-table-field-example:`CA` - The state or province for the billing address (``address_1`` and `address_2, if applicable`). * - :action-table-field-name:`tax_id` - :action-table-field-type:`str` - :action-table-field-example:`ATU99999999` - The tax identification number for this child account. * - :action-table-field-name:`zip` - :action-table-field-type:`str` - :action-table-field-example:`92111-1234` - The zip code of this Account's billing address. .. _commands_child-account_list_attribute_sections_credit_card: .. rst-class:: action-section-header credit_card .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`credit_card.expiry` - :action-table-field-type:`str` - :action-table-field-example:`11/2024` - The expiration month and year of the credit card. * - :action-table-field-name:`credit_card.last_four` - :action-table-field-type:`str` - :action-table-field-example:`1111` - The last four digits of the credit card. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_child-account_view: `view `_ ---------------------------------------------------------------------------- View a specific child account based on its ``euuid``. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli child-account view [-h] [--phone phone] [--company company] [--email email] [--last_name last_name] [--country country] [--address_1 address_1] [--city city] [--state state] [--first_name first_name] [--address_2 address_2] [--zip zip] [--order-by {phone,company,email,last_name,country,address_1,city,state,first_name,address_2,zip}] [--order {asc,desc}] euuid .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli child-account view A1BC2DEF-34GH-567I-J890KLMN12O34P56 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`euuid` - :action-table-field-type:`str` - The child account to look up. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`active_since` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - The activation date and time for the child account. * - :action-table-field-name:`address_1` - :action-table-field-type:`str` - :action-table-field-example:`123 Main Street` - First line of this child account's billing address. * - :action-table-field-name:`address_2` - :action-table-field-type:`str` - :action-table-field-example:`Suite A` - Second line of this child account's billing address, if applicable. * - :action-table-field-name:`balance` - :action-table-field-type:`float` - :action-table-field-example:`200` - This child account's balance, in US dollars. * - :action-table-field-name:`balance_uninvoiced` - :action-table-field-type:`float` - :action-table-field-example:`145` - This child account's current estimated invoice in US dollars. * - :action-table-field-name:`billing_source` - :action-table-field-type:`str` - :action-table-field-example:`external` - The source of service charges for this account, as determined by its relationship with Akamai. * - :action-table-field-name:`capabilities` - :action-table-field-type:`[]str` - :action-table-field-example:`["Linodes", "...ct Storage"]` - A list of the capabilities the child account supports. * - :action-table-field-name:`city` - :action-table-field-type:`str` - :action-table-field-example:`San Diego` - The city for this child account's billing address. * - :action-table-field-name:`company` - :action-table-field-type:`str` - :action-table-field-example:`Acme` - The company name for the owner of this child account. * - :action-table-field-name:`country` - :action-table-field-type:`str` - :action-table-field-example:`US` - The two-letter ISO 3166 country code for this child account's billing address. * - :action-table-field-name:`email` - :action-table-field-type:`str` - :action-table-field-example:`john.smith@linode.com` - The email address of the owner of this child account. * - :action-table-field-name:`euuid` - :action-table-field-type:`str` - :action-table-field-example:`A1BC2DEF-34GH...KLMN12O34P56` - An external, unique identifier that Akamai assigned to the child account. * - :action-table-field-name:`first_name` - :action-table-field-type:`str` - :action-table-field-example:`John` - The first name of the owner of this child account. * - :action-table-field-name:`last_name` - :action-table-field-type:`str` - :action-table-field-example:`Smith` - The last name of the owner of this child account. * - :action-table-field-name:`phone` - :action-table-field-type:`str` - :action-table-field-example:`858-555-1212` - The phone number for the owner of this child account. * - :action-table-field-name:`state` - :action-table-field-type:`str` - :action-table-field-example:`CA` - The state or province for the billing address (``address_1`` and `address_2, if applicable`). * - :action-table-field-name:`tax_id` - :action-table-field-type:`str` - :action-table-field-example:`ATU99999999` - The tax identification number for this child account. * - :action-table-field-name:`zip` - :action-table-field-type:`str` - :action-table-field-example:`92111-1234` - The zip code of this Account's billing address. .. _commands_child-account_view_attribute_sections_credit_card: .. rst-class:: action-section-header credit_card .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`credit_card.expiry` - :action-table-field-type:`str` - :action-table-field-example:`11/2024` - The expiration month and year of the credit card. * - :action-table-field-name:`credit_card.last_four` - :action-table-field-type:`str` - :action-table-field-example:`1111` - The last four digits of the credit card. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_child-account_create: `create `_ ------------------------------------------------------------------------------------- Create a short-lived bearer token for a parent user on a child account, using the ``euuid`` of that child account. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli child-account create [-h] euuid .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli child-account create A1BC2DEF-34GH-567I-J890KLMN12O34P56 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`euuid` - :action-table-field-type:`str` - The child account to look up. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`created` - :action-table-field-type:`str` - :action-table-field-example:`2024-05-01T00:01:01` - The date and time this token was created. * - :action-table-field-name:`expiry` - :action-table-field-type:`str` - :action-table-field-example:`2024-05-01T00:16:01` - When this token expires. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`918` - The proxy user token's unique ID, which can be used to revoke it. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`parent1_1234...-01T00:01:01` - The name of the token. * - :action-table-field-name:`scopes` - :action-table-field-type:`str` - :action-table-field-example:`*` - The scopes this token was created with. * - :action-table-field-name:`token` - :action-table-field-type:`str` - :action-table-field-example:`abcdefghijklmnop` - The proxy user token that can be used to access the API and CLI.