> For the complete documentation index, see [llms.txt](https://cloudforet.gitbook.io/cloudforet-apis/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cloudforet.gitbook.io/cloudforet-apis/content/en/identity/v2/domain.md).

# Domain

> **Package : spaceone.api.identity.v2**

\ <br>

## Domain

**Domain Methods:**

| Method                                                                                                                              | Request                                                                                                                                     | Response                                                                                                                                      |
| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| [**create**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#create)                   | [CreateDomainRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#createdomainrequest)     | [DomainInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#domaininfo)                         |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#update)                   | [UpdateDomainRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#updatedomainrequest)     | [DomainInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#domaininfo)                         |
| [**delete**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#delete)                   | [DomainRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#domainrequest)                 | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#empty)                                   |
| [**enable**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#enable)                   | [DomainRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#domainrequest)                 | [DomainInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#domaininfo)                         |
| [**disable**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#disable)                 | [DomainRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#domainrequest)                 | [DomainInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#domaininfo)                         |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#get)                         | [DomainRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#domainrequest)                 | [DomainInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#domaininfo)                         |
| [**get\_auth\_info**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#get_auth_info)   | [GetDomainAuthRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#getdomainauthrequest)   | [DomainAuthInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#domainauthinfo)                 |
| [**get\_public\_key**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#get_public_key) | [AuthenticationRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#authenticationrequest) | [AuthenticationResponse](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#authenticationresponse) |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#list)                       | [DomainSearchQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#domainsearchquery)         | [DomainsInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#domainsinfo)                       |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#stat)                       | [DomainStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#domainstatquery)             | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#struct)                                 |

<br>

### create

> **POST** /identity/v2/domain/create

{{< tabs " create " >}}

{{< tab "Request Example" >}}

[CreateDomainRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#createdomainrequest)

* **name** (string) `Required`
* **admin** (Admin) `Required`
* **tags** (Struct)

{{< highlight json >}} { "name": "wonny-dev", "admin": { "user\_id": "<wonny@cloudforet.io>", "name": "Wonny", "password": "Password1234!", "email": "<wonny@cloudforet.io>", "language": "en", "timezone": "UTC" } } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[DomainInfo](#DOMAININFO)

* **domain\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **tags** (Struct) `Required`
* **created\_at** (string) `Required`
* **deleted\_at** (string) `Required`

{{< highlight json >}} { "domain\_id": "domain-a1b2c3d4e5f6", "name": "wonny-dev", "state": "ENABLED", "created\_at": "2024-11-12T02:24:01.233Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### update

> **POST** /identity/v2/domain/update

{{< tabs " update " >}}

{{< tab "Request Example" >}}

[UpdateDomainRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#updatedomainrequest)

* **domain\_id** (string) `Required`
* **name** (string)
* **tags** (Struct)

{{< highlight json >}} { "domain\_id": "domain-a1b2c3d4e5f6", "name": "wonny-dev" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[DomainInfo](#DOMAININFO)

* **domain\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **tags** (Struct) `Required`
* **created\_at** (string) `Required`
* **deleted\_at** (string) `Required`

{{< highlight json >}} { "domain\_id": "domain-a1b2c3d4e5f6", "name": "wonny-dev", "state": "ENABLED", "created\_at": "2024-11-12T02:24:01.233Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### delete

> **POST** /identity/v2/domain/delete

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

[DomainRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#domainrequest)

* **domain\_id** (string) `Required`

{{< highlight json >}} { "domain\_id": "domain-a1b2c3d4e5f6" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### enable

> **POST** /identity/v2/domain/enable

{{< tabs " enable " >}}

{{< tab "Request Example" >}}

[DomainRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#domainrequest)

* **domain\_id** (string) `Required`

{{< highlight json >}} { "domain\_id": "domain-a1b2c3d4e5f6" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[DomainInfo](#DOMAININFO)

* **domain\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **tags** (Struct) `Required`
* **created\_at** (string) `Required`
* **deleted\_at** (string) `Required`

{{< highlight json >}} { "domain\_id": "domain-a1b2c3d4e5f6", "name": "wonny-dev", "state": "ENABLED", "created\_at": "2024-11-12T02:24:01.233Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### disable

> **POST** /identity/v2/domain/disable

{{< tabs " disable " >}}

{{< tab "Request Example" >}}

[DomainRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#domainrequest)

* **domain\_id** (string) `Required`

{{< highlight json >}} { "domain\_id": "domain-a1b2c3d4e5f6" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[DomainInfo](#DOMAININFO)

* **domain\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **tags** (Struct) `Required`
* **created\_at** (string) `Required`
* **deleted\_at** (string) `Required`

{{< highlight json >}} { "domain\_id": "domain-a1b2c3d4e5f6", "name": "wonny-dev", "state": "ENABLED", "created\_at": "2024-11-12T02:24:01.233Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### get

> **POST** /identity/v2/domain/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

[DomainRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#domainrequest)

* **domain\_id** (string) `Required`

{{< highlight json >}} { "domain\_id": "domain-a1b2c3d4e5f6" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[DomainInfo](#DOMAININFO)

* **domain\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **tags** (Struct) `Required`
* **created\_at** (string) `Required`
* **deleted\_at** (string) `Required`

{{< highlight json >}} { "domain\_id": "domain-a1b2c3d4e5f6", "name": "wonny-dev", "state": "ENABLED", "created\_at": "2024-11-12T02:24:01.233Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### get\_auth\_info

+noauth

> **POST** /identity/v2/domain/get-auth-info

{{< tabs " get\_auth\_info " >}}

{{< tab "Request Example" >}}

[GetDomainAuthRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#getdomainauthrequest)

* **name** (string) `Required`

{{< highlight json >}} { "name": "wonny-dev" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[DomainAuthInfo](#DOMAINAUTHINFO)

* **domain\_id** (string) `Required`
* **name** (string) `Required`
* **external\_auth\_state** (ExternalAuthState) `Required`
* **metadata** (Struct) `Required`
* **config** (Struct) `Required`

{{< highlight json >}} { "domain\_id": "domain-a1b2c3d4e5f6", "name": "wonny-dev", "external\_auth\_state": "DISABLED", "metadata": {}, "config": { "settings": { "unified\_cost\_config": { "aggregation\_day": 15.0, "currency": "KRW", "custom\_exchange\_rate": {}, "exchange\_date": 15.0, "exchange\_rate\_mode": "AUTO", "exchange\_source": "Yahoo! Finance", "is\_exchange\_last\_day": false, "is\_last\_day": false, "run\_hour": 0.0 } } } } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### get\_public\_key

<br>

### list

> **POST** /identity/v2/domain/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

[DomainSearchQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Domain/README.md#domainsearchquery)

* **query** (Query)
* **domain\_id** (string)
* **name** (string)
* **state** (State)

{{< highlight json >}} { "query": { "filter": \[{ "k": "tag.env", "v": "dev", "o": "eq" }], "sort": \[{ "key": "created\_at", "desc": true }] } } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[DomainsInfo](#DOMAINSINFO)

* **results** (DomainInfo) `Repeated` `Required`
* **total\_count** (int32) `Required`

{{< highlight json >}} { "results": \[ { "domain\_id": "domain-a1b2c3d4e5f6", "name": "wonny-dev1", "state": "ENABLED", "created\_at": "2024-11-12T02:24:01.233Z" }, { "domain\_id": "domain-g7h8i9j1k2l3", "name": "wonny-dev2", "state": "ENABLED", "created\_at": "2024-11-01T03:34:01.233Z" } ], "total\_count": 2 } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### stat

\ <br>

## Message

### Admin

* **user\_id** (string) `Required`
* **name** (string) `Required`
* **password** (string) `Required`
* **email** (string)
* **language** (string)
* **timezone** (string)
* **tags** (Struct)
* **reset\_password** (bool)

  <br>

### CreateDomainRequest

* **name** (string) `Required`
* **admin** (Admin) `Required`
* **tags** (Struct)

  <br>

### DomainAuthInfo

* **domain\_id** (string) `Required`
* **name** (string) `Required`
* **external\_auth\_state** (ExternalAuthState) `Required`
* **metadata** (Struct) `Required`
* **config** (Struct) `Required`

  <br>

### DomainInfo

* **domain\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **tags** (Struct) `Required`
* **created\_at** (string) `Required`
* **deleted\_at** (string) `Required`

  <br>

### DomainRequest

* **domain\_id** (string) `Required`

  <br>

### DomainSearchQuery

* **query** (Query)
* **domain\_id** (string)
* **name** (string)
* **state** (State)

  <br>

### DomainStatQuery

* **query** (StatisticsQuery) `Required`

  <br>

### DomainsInfo

* **results** (DomainInfo) `Repeated` `Required`
* **total\_count** (int32) `Required`

  <br>

### GetDomainAuthRequest

* **name** (string) `Required`

  <br>

### UpdateDomainRequest

* **domain\_id** (string) `Required`
* **name** (string)
* **tags** (Struct)

  <br>