> 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/schema.md).

# Schema

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

\ <br>

## Schema

**Schema Methods:**

| Method                                                                                                            | Request                                                                                                                                 | Response                                                                                                                |
| ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| [**create**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Schema/README.md#create) | [CreateSchemaRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Schema/README.md#createschemarequest) | [SchemaInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Schema/README.md#schemainfo)   |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Schema/README.md#update) | [UpdateSchemaRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Schema/README.md#updateschemarequest) | [SchemaInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Schema/README.md#schemainfo)   |
| [**delete**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Schema/README.md#delete) | [SchemaRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Schema/README.md#schemarequest)             | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Schema/README.md#empty)             |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Schema/README.md#get)       | [SchemaRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Schema/README.md#schemarequest)             | [SchemaInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Schema/README.md#schemainfo)   |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Schema/README.md#list)     | [SchemaSearchQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Schema/README.md#schemasearchquery)     | [SchemasInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Schema/README.md#schemasinfo) |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Schema/README.md#stat)     | [SchemaStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Schema/README.md#schemastatquery)         | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Schema/README.md#struct)           |

<br>

### create

> **POST** /identity/v2/schema/create

{{< tabs " create " >}}

{{< tab "Request Example" >}}

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

* **schema\_id** (string) `Required`
* **name** (string) `Required`
* **schema\_type** (SchemaType) `Required`
* **provider** (string) `Required`
* **schema** (Struct)
* **related\_schemas** (string) `Repeated`
* **options** (Struct)
* **tags** (Struct)

{{< highlight json >}} { "schema\_id": "aws-secret-access-key", "name": "AWS Access Key", "schema\_type": "SECRET", "provider": "aws" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[SchemaInfo](#SCHEMAINFO)

* **schema\_id** (string) `Required`
* **name** (string) `Required`
* **schema\_type** (SchemaType) `Required`
* **schema** (Struct) `Required`
* **provider** (string) `Required`
* **related\_schemas** (string) `Repeated` `Required`
* **options** (Struct) `Required`
* **tags** (Struct) `Required`
* **is\_managed** (bool) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

{{< highlight json >}} { "created\_at": "2024-11-18T01:59:00.407Z", "domain\_id": "domain-a1b2c3d4e5f6", "name": "AWS Access Key", "provider": "aws", "schema": { "order": \[ "aws\_access\_key\_id", "aws\_secret\_access\_key" ], "properties": { "aws\_access\_key\_id": { "format": "password", "minLength": 4.0, "title": "AWS Access Key", "type": "string" }, "aws\_secret\_access\_key": { "format": "password", "minLength": 4.0, "title": "AWS Secret Key", "type": "string" } }, "required": \[ "aws\_access\_key\_id", "aws\_secret\_access\_key" ], "type": "object" }, "schema\_id": "aws-secret-access-key", "schema\_type": "SECRET", "updated\_at": "2024-11-18T02:00:45.792Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### update

> **POST** /identity/v2/schema/update

{{< tabs " update " >}}

{{< tab "Request Example" >}}

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

* **schema\_id** (string) `Required`
* **name** (string)
* **schema** (Struct)
* **related\_schemas** (string) `Repeated`
* **options** (Struct)
* **tags** (Struct)

{{< highlight json >}} { "schema\_id": "aws-secret-access-key1", "schema": { "order": \[ "aws\_access\_key\_id", "aws\_secret\_access\_key" ], "properties": { "aws\_access\_key\_id": { "format": "password", "minLength": 4.0, "title": "AWS Access Key", "type": "string" }, "aws\_secret\_access\_key": { "format": "password", "minLength": 4.0, "title": "AWS Secret Key", "type": "string" } }, "required": \[ "aws\_access\_key\_id", "aws\_secret\_access\_key" ], "type": "object" } } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[SchemaInfo](#SCHEMAINFO)

* **schema\_id** (string) `Required`
* **name** (string) `Required`
* **schema\_type** (SchemaType) `Required`
* **schema** (Struct) `Required`
* **provider** (string) `Required`
* **related\_schemas** (string) `Repeated` `Required`
* **options** (Struct) `Required`
* **tags** (Struct) `Required`
* **is\_managed** (bool) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

{{< highlight json >}} { "created\_at": "2024-11-18T01:59:00.407Z", "domain\_id": "domain-a1b2c3d4e5f6", "name": "AWS Access Key", "provider": "aws", "schema": { "order": \[ "aws\_access\_key\_id", "aws\_secret\_access\_key" ], "properties": { "aws\_access\_key\_id": { "format": "password", "minLength": 4.0, "title": "AWS Access Key", "type": "string" }, "aws\_secret\_access\_key": { "format": "password", "minLength": 4.0, "title": "AWS Secret Key", "type": "string" } }, "required": \[ "aws\_access\_key\_id", "aws\_secret\_access\_key" ], "type": "object" }, "schema\_id": "aws-secret-access-key", "schema\_type": "SECRET", "updated\_at": "2024-11-18T02:00:45.792Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### delete

> **POST** /identity/v2/schema/delete

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

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

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

{{< highlight json >}} { "schema\_id": "aws-secret-access-key" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### get

> **POST** /identity/v2/schema/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

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

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

{{< highlight json >}} { "schema\_id": "aws-secret-access-key" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[SchemaInfo](#SCHEMAINFO)

* **schema\_id** (string) `Required`
* **name** (string) `Required`
* **schema\_type** (SchemaType) `Required`
* **schema** (Struct) `Required`
* **provider** (string) `Required`
* **related\_schemas** (string) `Repeated` `Required`
* **options** (Struct) `Required`
* **tags** (Struct) `Required`
* **is\_managed** (bool) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

{{< highlight json >}} { "created\_at": "2024-11-18T01:59:00.407Z", "domain\_id": "domain-a1b2c3d4e5f6", "name": "AWS Access Key", "provider": "aws", "schema": { "order": \[ "aws\_access\_key\_id", "aws\_secret\_access\_key" ], "properties": { "aws\_access\_key\_id": { "format": "password", "minLength": 4.0, "title": "AWS Access Key", "type": "string" }, "aws\_secret\_access\_key": { "format": "password", "minLength": 4.0, "title": "AWS Secret Key", "type": "string" } }, "required": \[ "aws\_access\_key\_id", "aws\_secret\_access\_key" ], "type": "object" }, "schema\_id": "aws-secret-access-key", "schema\_type": "SECRET", "updated\_at": "2024-11-18T02:00:45.792Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### list

> **POST** /identity/v2/schema/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

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

* **query** (Query)
* **schema\_id** (string)
* **name** (string)
* **schema\_type** (SchemaType)
* **provider** (string)
* **related\_schema\_id** (string)
* **is\_managed** (bool)

{{< highlight json >}} { "provider": "aws", "query": { "page": { "start": 1, "limit": 10 }, "sort": \[ { "key": "created\_at", "desc": true } ] } } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[SchemasInfo](#SCHEMASINFO)

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

{{< highlight json >}} { "results": \[ { "created\_at": "2024-11-18T02:08:10.216Z", "domain\_id": "domain-a1b2c3d4e5f6", "name": "AWS Trusted Account", "provider": "aws", "schema": { "properties": { "account\_id": { "minLength": 4.0, "title": "Account ID", "type": "string" } }, "required": \[ "account\_id" ], "type": "object" }, "schema\_id": "aws-trusted-account", "schema\_type": "TRUSTED\_ACCOUNT", "updated\_at": "2024-11-18T02:08:10.216Z" }, { "created\_at": "2024-11-18T01:59:00.407Z", "domain\_id": "domain-a1b2c3d4e5f6", "name": "AWS Access Key", "provider": "aws", "schema": { "order": \[ "aws\_access\_key\_id", "aws\_secret\_access\_key" ], "properties": { "aws\_access\_key\_id": { "format": "password", "minLength": 4.0, "title": "AWS Access Key", "type": "string" }, "aws\_secret\_access\_key": { "format": "password", "minLength": 4.0, "title": "AWS Secret Key", "type": "string" } }, "required": \[ "aws\_access\_key\_id", "aws\_secret\_access\_key" ], "type": "object" }, "schema\_id": "aws-secret-access-key", "schema\_type": "SECRET", "updated\_at": "2024-11-18T02:00:45.792Z" } ], "total\_count": 2 } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### stat

> **POST** /identity/v2/schema/stat

\ <br>

## Message

### CreateSchemaRequest

* **schema\_id** (string) `Required`
* **name** (string) `Required`
* **schema\_type** (SchemaType) `Required`
* **provider** (string) `Required`
* **schema** (Struct)
* **related\_schemas** (string) `Repeated`
* **options** (Struct)
* **tags** (Struct)

  <br>

### SchemaInfo

* **schema\_id** (string) `Required`
* **name** (string) `Required`
* **schema\_type** (SchemaType) `Required`
* **schema** (Struct) `Required`
* **provider** (string) `Required`
* **related\_schemas** (string) `Repeated` `Required`
* **options** (Struct) `Required`
* **tags** (Struct) `Required`
* **is\_managed** (bool) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

  <br>

### SchemaRequest

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

  <br>

### SchemaSearchQuery

* **query** (Query)
* **schema\_id** (string)
* **name** (string)
* **schema\_type** (SchemaType)
* **provider** (string)
* **related\_schema\_id** (string)
* **is\_managed** (bool)

  <br>

### SchemaStatQuery

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

  <br>

### SchemasInfo

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

  <br>

### UpdateSchemaRequest

* **schema\_id** (string) `Required`
* **name** (string)
* **schema** (Struct)
* **related\_schemas** (string) `Repeated`
* **options** (Struct)
* **tags** (Struct)

  <br>