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

# Domain

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

## Domain

{% hint style="info" %}
**Domain Methods:**
{% endhint %}

| Method                                          | Request                                     | Response                                                                                                           |
| ----------------------------------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| [**create**](#create)                           | [CreateDomainRequest](#createdomainrequest) | [DomainInfo](#domaininfo)                                                                                          |
| [**update**](#update)                           | [UpdateDomainRequest](#updatedomainrequest) | [DomainInfo](#domaininfo)                                                                                          |
| [**change\_auth\_plugin**](#change_auth_plugin) | [ChangeAuthRequest](#changeauthrequest)     | [DomainInfo](#domaininfo)                                                                                          |
| [**update\_plugin**](#update_plugin)            | [UpdatePluginRequest](#updatepluginrequest) | [DomainInfo](#domaininfo)                                                                                          |
| [**verify\_plugin**](#verify_plugin)            | [DomainRequest](#domainrequest)             | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto)   |
| [**delete**](#delete)                           | [DomainRequest](#domainrequest)             | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto)   |
| [**enable**](#enable)                           | [DomainRequest](#domainrequest)             | [DomainInfo](#domaininfo)                                                                                          |
| [**disable**](#disable)                         | [DomainRequest](#domainrequest)             | [DomainInfo](#domaininfo)                                                                                          |
| [**get**](#get)                                 | [GetDomainRequest](#getdomainrequest)       | [DomainInfo](#domaininfo)                                                                                          |
| [**list**](#list)                               | [DomainQuery](#domainquery)                 | [DomainsInfo](#domainsinfo)                                                                                        |
| [**stat**](#stat)                               | [DomainStatQuery](#domainstatquery)         | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |
| [**get\_public\_key**](#get_public_key)         | .spaceone.api.core.v1.AuthenticationRequest | .spaceone.api.core.v1.AuthenticationResponse                                                                       |

### create

> **POST** /identity/v1/domains

| Type     | Message                                     |
| -------- | ------------------------------------------- |
| Request  | [CreateDomainRequest](#createdomainrequest) |
| Response | [DomainInfo](#domaininfo)                   |

### update

> **PUT** /identity/v1/domain/{domain\_id}

| Type     | Message                                     |
| -------- | ------------------------------------------- |
| Request  | [UpdateDomainRequest](#updatedomainrequest) |
| Response | [DomainInfo](#domaininfo)                   |

### change\_auth\_plugin

> **PUT** /identity/v1/domain/{domain\_id}/change\_auth\_plugin

| Type     | Message                                 |
| -------- | --------------------------------------- |
| Request  | [ChangeAuthRequest](#changeauthrequest) |
| Response | [DomainInfo](#domaininfo)               |

### update\_plugin

> **PUT** /identity/v1/domain/{domain\_id}/plugin

| Type     | Message                                     |
| -------- | ------------------------------------------- |
| Request  | [UpdatePluginRequest](#updatepluginrequest) |
| Response | [DomainInfo](#domaininfo)                   |

### verify\_plugin

> **POST** /identity/v1/domain/{domain\_id}/plugin/verify

| Type     | Message                                                                                                          |
| -------- | ---------------------------------------------------------------------------------------------------------------- |
| Request  | [DomainRequest](#domainrequest)                                                                                  |
| Response | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) |

### delete

> **DELETE** /identity/v1/domain/{domain\_id}

| Type     | Message                                                                                                          |
| -------- | ---------------------------------------------------------------------------------------------------------------- |
| Request  | [DomainRequest](#domainrequest)                                                                                  |
| Response | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) |

### enable

> **PUT** /identity/v1/domain/{domain\_id}

| Type     | Message                         |
| -------- | ------------------------------- |
| Request  | [DomainRequest](#domainrequest) |
| Response | [DomainInfo](#domaininfo)       |

### disable

> **PUT** /identity/v1/domain/{domain\_id}

| Type     | Message                         |
| -------- | ------------------------------- |
| Request  | [DomainRequest](#domainrequest) |
| Response | [DomainInfo](#domaininfo)       |

### get

> **GET** /identity/v1/domain/{domain\_id}

| Type     | Message                               |
| -------- | ------------------------------------- |
| Request  | [GetDomainRequest](#getdomainrequest) |
| Response | [DomainInfo](#domaininfo)             |

### list

> **GET** /identity/v1/domains
>
> **POST** /identity/v1/domains/search

| Type     | Message                     |
| -------- | --------------------------- |
| Request  | [DomainQuery](#domainquery) |
| Response | [DomainsInfo](#domainsinfo) |

### stat

> **POST** /identity/v1/domains/stat

| Type     | Message                                                                                                            |
| -------- | ------------------------------------------------------------------------------------------------------------------ |
| Request  | [DomainStatQuery](#domainstatquery)                                                                                |
| Response | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |

### get\_public\_key

| Type     | Message                                      |
| -------- | -------------------------------------------- |
| Request  | \[AuthenticationRequest]                     |
| Response | .spaceone.api.core.v1.AuthenticationResponse |

##

## Message

### ChangeAuthRequest

| Field                 | Type                      | Required | Description |
| --------------------- | ------------------------- | :------: | ----------- |
| domain\_id            | string                    |     ✔    |             |
| plugin\_info          | [PluginInfo](#plugininfo) |     ✘    |             |
| release\_auth\_plugin | bool                      |     ✘    |             |

### CreateDomainRequest

| Field        | Type                                                                                                               | Required | Description |
| ------------ | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- |
| name         | string                                                                                                             |     ✔    |             |
| plugin\_info | [PluginInfo](#plugininfo)                                                                                          |     ✘    |             |
| config       | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |
| tags         | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |

### DomainInfo

| Field        | Type                                                                                                               | Description |
| ------------ | ------------------------------------------------------------------------------------------------------------------ | ----------- |
| domain\_id   | string                                                                                                             |             |
| name         | string                                                                                                             |             |
| state        | <ul><li>NONE</li><li>ENABLED</li><li>DISABLED</li></ul>                                                            |             |
| plugin\_info | [PluginInfo](#plugininfo)                                                                                          |             |
| config       | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |             |
| tags         | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |             |
| created\_at  | string                                                                                                             |             |
| deleted\_at  | string                                                                                                             |             |

### DomainQuery

| Field      | Type                                                                                               | Required | Description |
| ---------- | -------------------------------------------------------------------------------------------------- | -------- | ----------- |
| query      | [spaceone.api.core.v1.Query](https://spaceone-dev.gitbook.io/api-reference/common-v1/search-query) | ✘        |             |
| domain\_id | string                                                                                             | ✘        |             |
| name       | string                                                                                             | ✘        |             |
| state      | <ul><li>NONE</li><li>ENABLED</li><li>DISABLED</li></ul>                                            | ✘        |             |

### DomainRequest

| Field      | Type   | Required | Description |
| ---------- | ------ | :------: | ----------- |
| domain\_id | string |     ✔    |             |

### DomainStatQuery

| Field | Type                                                                                                             | Required | Description |
| ----- | ---------------------------------------------------------------------------------------------------------------- | :------: | ----------- |
| query | [spaceone.api.core.v1.StatisticsQuery](https://spaceone-dev.gitbook.io/api-reference/common-v1/statistics-query) |     ✔    |             |

### DomainsInfo

| Field        | Type                                                                                            | Description |
| ------------ | ----------------------------------------------------------------------------------------------- | ----------- |
| results      | [list of DomainInfo](#domaininfo)                                                               |             |
| total\_count | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) |             |

### GetDomainRequest

| Field      | Type           | Required | Description |
| ---------- | -------------- | :------: | ----------- |
| domain\_id | string         |     ✔    |             |
| only       | list of string |     ✘    |             |

### PluginInfo

| Field         | Type                                                                                                               | Description |
| ------------- | ------------------------------------------------------------------------------------------------------------------ | ----------- |
| plugin\_id    | string                                                                                                             |             |
| version       | string                                                                                                             |             |
| secret\_id    | string                                                                                                             |             |
| options       | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |             |
| secret\_data  | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |             |
| schema        | string                                                                                                             |             |
| metadata      | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |             |
| upgrade\_mode | <ul><li>NONE</li><li>MANUAL</li><li>AUTO</li></ul>                                                                 |             |

### UpdateDomainRequest

| Field        | Type                                                                                                               | Required | Description |
| ------------ | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- |
| domain\_id   | string                                                                                                             |     ✔    |             |
| plugin\_info | [PluginInfo](#plugininfo)                                                                                          |     ✘    |             |
| config       | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |
| tags         | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |

### UpdatePluginRequest

| Field         | Type                                                                                                               | Required | Description |
| ------------- | ------------------------------------------------------------------------------------------------------------------ | -------- | ----------- |
| domain\_id    | string                                                                                                             | ✔        |             |
| version       | string                                                                                                             | ✘        |             |
| options       | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | ✘        |             |
| upgrade\_mode | <ul><li>NONE</li><li>MANUAL</li><li>AUTO</li></ul>                                                                 | ✘        |             |