mirror of
https://github.com/GAM-team/GAM.git
synced 2026-06-18 13:11:37 +00:00
caddda2b1c
Some checks failed
Build and test GAM / build (Win64, build, 7, VC-WIN64A, windows-2022) (push) Has been cancelled
Build and test GAM / build (aarch64, build, 2, linux-aarch64, [self-hosted linux arm64]) (push) Has been cancelled
Build and test GAM / build (aarch64, build, 4, linux-aarch64, [self-hosted linux arm64], yes) (push) Has been cancelled
Build and test GAM / build (aarch64, build, 6, darwin64-arm64, macos-14) (push) Has been cancelled
Build and test GAM / build (x86_64, build, 1, linux-x86_64, ubuntu-22.04) (push) Has been cancelled
Build and test GAM / build (x86_64, build, 3, linux-x86_64, ubuntu-22.04, yes) (push) Has been cancelled
Build and test GAM / build (x86_64, build, 5, darwin64-x86_64, macos-13) (push) Has been cancelled
Build and test GAM / build (x86_64, test, 10, ubuntu-24.04, 3.10) (push) Has been cancelled
Build and test GAM / build (x86_64, test, 11, ubuntu-24.04, 3.11) (push) Has been cancelled
Build and test GAM / build (x86_64, test, 8, ubuntu-24.04, 3.13) (push) Has been cancelled
Build and test GAM / build (x86_64, test, 9, ubuntu-24.04, 3.9) (push) Has been cancelled
CodeQL / Analyze (python) (push) Has been cancelled
Check for Google Root CA Updates / check-apis (push) Has been cancelled
Build and test GAM / merge (push) Has been cancelled
Build and test GAM / publish (push) Has been cancelled
97 lines
3.7 KiB
Markdown
97 lines
3.7 KiB
Markdown
!# Domains
|
|
- [API documentation](#api-documentation)
|
|
- [Definitions](#definitions)
|
|
- [Create a domain](#create-a-domain)
|
|
- [Promote a domain to be primary](#promote-a-domain-to-be-primary)
|
|
- [Delete a domain](#delete-a-domain)
|
|
- [Display domains](#display-domains)
|
|
- [Display domains count](#display-domains-count)
|
|
- [Create and delete domain aliases](#create-and-delete-domain-aliases)
|
|
- [Display domain aliases](#display-domain-aliases)
|
|
- [Display domain aliases count](#display-domain-aliases-count)
|
|
|
|
## API documentation
|
|
* https://developers.google.com/admin-sdk/directory/reference/rest/v1/domains
|
|
|
|
## Definitions
|
|
```
|
|
<DomainAlias> ::= <String>
|
|
<DomainName> ::= <String>(.<String>)+
|
|
```
|
|
## Create a domain
|
|
```
|
|
gam create domain <DomainName>
|
|
```
|
|
## Promote a domain to be primary
|
|
```
|
|
gam update domain <DomainName> primary
|
|
```
|
|
## Delete a domain
|
|
```
|
|
gam delete domain <DomainName>
|
|
```
|
|
## Display domains
|
|
```
|
|
gam info domain [<DomainName>]
|
|
[formatjson]
|
|
gam show domains
|
|
[formatjson]
|
|
```
|
|
For `info`, if `<DomainName>` is omitted, information about the primary domain will be displayed.
|
|
|
|
By default, Gam displays the information as an indented list of keys and values.
|
|
* `formatjson` - Display the fields in JSON format.
|
|
```
|
|
gam print domains [todrive <ToDriveAttribute>*]
|
|
[formatjson [quotechar <Character>]]
|
|
```
|
|
By default, Gam displays the information as columns of fields.
|
|
* `formatjson` - Display the fields in JSON format.
|
|
|
|
By default, when writing CSV files, Gam uses a quote character of double quote `"`. The quote character is used to enclose columns that contain
|
|
the quote character itself, the column delimiter (comma by default) and new-line characters. Any quote characters within the column are doubled.
|
|
When using the `formatjson` option, double quotes are used extensively in the data resulting in hard to read/process output.
|
|
The `quotechar <Character>` option allows you to choose an alternate quote character, single quote for instance, that makes for readable/processable output.
|
|
`quotechar` defaults to `gam.cfg/csv_output_quote_char`. When uploading CSV files to Google, double quote `"` should be used.
|
|
|
|
## Display domains count
|
|
Display the number of domains.
|
|
```
|
|
gam print|show domains
|
|
showitemcountonly
|
|
```
|
|
|
|
## Create and delete domain aliases
|
|
```
|
|
gam create domainalias|aliasdomain <DomainAlias> <DomainName>
|
|
gam delete domainalias|aliasdomain <DomainAlias>
|
|
```
|
|
## Display domain aliases
|
|
```
|
|
gam info domainalias|aliasdomain <DomainAlias>
|
|
[formatjson]
|
|
gam show domainaliases|aliasdomains
|
|
[formatjson]
|
|
```
|
|
By default, Gam displays the information as an indented list of keys and values.
|
|
* `formatjson` - Display the fields in JSON format.
|
|
```
|
|
gam print domainaliases|aliasdomains [todrive <ToDriveAttribute>*]
|
|
[formatjson [quotechar <Character>]]
|
|
```
|
|
By default, Gam displays the information as columns of fields.
|
|
* `formatjson` - Display the fields in JSON format.
|
|
|
|
By default, when writing CSV files, Gam uses a quote character of double quote `"`. The quote character is used to enclose columns that contain
|
|
the quote character itself, the column delimiter (comma by default) and new-line characters. Any quote characters within the column are doubled.
|
|
When using the `formatjson` option, double quotes are used extensively in the data resulting in hard to read/process output.
|
|
The `quotechar <Character>` option allows you to choose an alternate quote character, single quote for instance, that makes for readable/processable output.
|
|
`quotechar` defaults to `gam.cfg/csv_output_quote_char`. When uploading CSV files to Google, double quote `"` should be used.
|
|
|
|
## Display domain aliases count
|
|
Display the number of domain aliases.
|
|
```
|
|
gam print|show domainaliases|aliasdomains
|
|
showitemcountonly
|
|
```
|