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

# Project

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

\ <br>

## Project

**Project Methods:**

| Method                                                                                                                                           | Request                                                                                                                                              | Response                                                                                                                   |
| ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| [**create**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#create)                               | [CreateProjectRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#createprojectrequest)           | [ProjectInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#projectinfo)   |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#update)                               | [UpdateProjectRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#updateprojectrequest)           | [ProjectInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#projectinfo)   |
| [**update\_project\_type**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#update_project_type)   | [UpdateProjectTypeRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#updateprojecttyperequest)   | [ProjectInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#projectinfo)   |
| [**change\_project\_group**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#change_project_group) | [ChangeProjectGroupRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#changeprojectgrouprequest) | [ProjectInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#projectinfo)   |
| [**delete**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#delete)                               | [ProjectRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#projectrequest)                       | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#empty)               |
| [**add\_users**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#add_users)                        | [UsersProjectRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#usersprojectrequest)             | [ProjectInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#projectinfo)   |
| [**remove\_users**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#remove_users)                  | [UsersProjectRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#usersprojectrequest)             | [ProjectInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#projectinfo)   |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#get)                                     | [ProjectRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#projectrequest)                       | [ProjectInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#projectinfo)   |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#list)                                   | [ProjectSearchQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#projectsearchquery)               | [ProjectsInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#projectsinfo) |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#stat)                                   | [ProjectStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#projectstatquery)                   | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Project/README.md#struct)             |

<br>

### create

> **POST** /identity/v2/project/create

{{< tabs " create " >}}

{{< tab "Request Example" >}}

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

* **name** (string) `Required`
* **project\_type** (ProjectType) `Required`
* **tags** (Struct)
* **project\_group\_id** (string)

{{< highlight json >}} { "name": "Cloudforet Project", "project\_type": "PUBLIC" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[ProjectInfo](#PROJECTINFO)

* **project\_id** (string) `Required`
* **name** (string) `Required`
* **project\_type** (ProjectType) `Required`
* **tags** (Struct) `Required`
* **users** (string) `Repeated` `Required`
* **created\_by** (string) `Required`
* **reference\_id** (string) `Required`
* **is\_managed** (bool) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **project\_group\_id** (string) `Required`
* **trusted\_account\_id** (string) `Required`
* **created\_at** (string) `Required`
* **last\_synced\_at** (string) `Required`

{{< highlight json >}} { "project\_id": "project-a1b2c3d4e5f6", "name": "Cloudforet Project", "project\_type": "PUBLIC", "created\_by": "<wonny@cloudforet.io>", "domain\_id": "domain-a1b2c3d4e5f6", "workspace\_id": "workspace-a1b2c3d4e5f6", "created\_at": "2024-11-13T06:35:11.877Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### update

> **POST** /identity/v2/project/update

{{< tabs " update " >}}

{{< tab "Request Example" >}}

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

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

{{< highlight json >}} { "project\_id": "project-a1b2c3d4e5f6", "name": "Wonny Project" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[ProjectInfo](#PROJECTINFO)

* **project\_id** (string) `Required`
* **name** (string) `Required`
* **project\_type** (ProjectType) `Required`
* **tags** (Struct) `Required`
* **users** (string) `Repeated` `Required`
* **created\_by** (string) `Required`
* **reference\_id** (string) `Required`
* **is\_managed** (bool) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **project\_group\_id** (string) `Required`
* **trusted\_account\_id** (string) `Required`
* **created\_at** (string) `Required`
* **last\_synced\_at** (string) `Required`

{{< highlight json >}} { "project\_id": "project-a1b2c3d4e5f6", "name": "Cloudforet Project", "project\_type": "PUBLIC", "created\_by": "<wonny@cloudforet.io>", "domain\_id": "domain-a1b2c3d4e5f6", "workspace\_id": "workspace-a1b2c3d4e5f6", "created\_at": "2024-11-13T06:35:11.877Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### update\_project\_type

> **POST** /identity/v2/project/update-project-type

{{< tabs " update\_project\_type " >}}

{{< tab "Request Example" >}}

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

* **project\_id** (string) `Required`
* **project\_type** (ProjectType) `Required`

{{< highlight json >}} { "project\_id": "project-a1b2c3d4e5f6", "project\_type": "PRIVATE" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[ProjectInfo](#PROJECTINFO)

* **project\_id** (string) `Required`
* **name** (string) `Required`
* **project\_type** (ProjectType) `Required`
* **tags** (Struct) `Required`
* **users** (string) `Repeated` `Required`
* **created\_by** (string) `Required`
* **reference\_id** (string) `Required`
* **is\_managed** (bool) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **project\_group\_id** (string) `Required`
* **trusted\_account\_id** (string) `Required`
* **created\_at** (string) `Required`
* **last\_synced\_at** (string) `Required`

{{< highlight json >}} { "project\_id": "project-a1b2c3d4e5f6", "name": "Cloudforet Project", "project\_type": "PUBLIC", "created\_by": "<wonny@cloudforet.io>", "domain\_id": "domain-a1b2c3d4e5f6", "workspace\_id": "workspace-a1b2c3d4e5f6", "created\_at": "2024-11-13T06:35:11.877Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### change\_project\_group

> **POST** /identity/v2/project/change-project-group

{{< tabs " change\_project\_group " >}}

{{< tab "Request Example" >}}

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

* **project\_id** (string) `Required`
* **project\_group\_id** (string) `Required`

{{< highlight json >}} { "project\_group\_id": "pg-a1b2c3d4e5f6", "project\_id": "project-a1b2c3d4e5f6" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[ProjectInfo](#PROJECTINFO)

* **project\_id** (string) `Required`
* **name** (string) `Required`
* **project\_type** (ProjectType) `Required`
* **tags** (Struct) `Required`
* **users** (string) `Repeated` `Required`
* **created\_by** (string) `Required`
* **reference\_id** (string) `Required`
* **is\_managed** (bool) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **project\_group\_id** (string) `Required`
* **trusted\_account\_id** (string) `Required`
* **created\_at** (string) `Required`
* **last\_synced\_at** (string) `Required`

{{< highlight json >}} { "project\_id": "project-a1b2c3d4e5f6", "name": "Cloudforet Project", "project\_type": "PUBLIC", "created\_by": "<wonny@cloudforet.io>", "domain\_id": "domain-a1b2c3d4e5f6", "workspace\_id": "workspace-a1b2c3d4e5f6", "created\_at": "2024-11-13T06:35:11.877Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### delete

> **POST** /identity/v2/project/delete

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

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

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

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

{{< /tabs >}}

<br>

### add\_users

> **POST** /identity/v2/project/add-users

{{< tabs " add\_users " >}}

{{< tab "Request Example" >}}

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

* **project\_id** (string) `Required`
* **users** (string) `Repeated` `Required`

{{< highlight json >}} { "project\_id": "project-a1b2c3d4e5f6", "users": \["<cloudforet@cloudforet.io>", "<wonny@cloudforet.io>"] } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[ProjectInfo](#PROJECTINFO)

* **project\_id** (string) `Required`
* **name** (string) `Required`
* **project\_type** (ProjectType) `Required`
* **tags** (Struct) `Required`
* **users** (string) `Repeated` `Required`
* **created\_by** (string) `Required`
* **reference\_id** (string) `Required`
* **is\_managed** (bool) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **project\_group\_id** (string) `Required`
* **trusted\_account\_id** (string) `Required`
* **created\_at** (string) `Required`
* **last\_synced\_at** (string) `Required`

{{< highlight json >}} { "project\_id": "project-a1b2c3d4e5f6", "name": "Cloudforet Project", "project\_type": "PUBLIC", "created\_by": "<wonny@cloudforet.io>", "domain\_id": "domain-a1b2c3d4e5f6", "workspace\_id": "workspace-a1b2c3d4e5f6", "created\_at": "2024-11-13T06:35:11.877Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### remove\_users

> **POST** /identity/v2/project/remove-users

{{< tabs " remove\_users " >}}

{{< tab "Request Example" >}}

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

* **project\_id** (string) `Required`
* **users** (string) `Repeated` `Required`

{{< highlight json >}} { "project\_id": "project-a1b2c3d4e5f6", "users": \["<cloudforet@cloudforet.io>", "<wonny@cloudforet.io>"] } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[ProjectInfo](#PROJECTINFO)

* **project\_id** (string) `Required`
* **name** (string) `Required`
* **project\_type** (ProjectType) `Required`
* **tags** (Struct) `Required`
* **users** (string) `Repeated` `Required`
* **created\_by** (string) `Required`
* **reference\_id** (string) `Required`
* **is\_managed** (bool) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **project\_group\_id** (string) `Required`
* **trusted\_account\_id** (string) `Required`
* **created\_at** (string) `Required`
* **last\_synced\_at** (string) `Required`

{{< highlight json >}} { "project\_id": "project-a1b2c3d4e5f6", "name": "Cloudforet Project", "project\_type": "PUBLIC", "created\_by": "<wonny@cloudforet.io>", "domain\_id": "domain-a1b2c3d4e5f6", "workspace\_id": "workspace-a1b2c3d4e5f6", "created\_at": "2024-11-13T06:35:11.877Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### get

> **POST** /identity/v2/project/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

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

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

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

{{< tab "Response Example" >}}

[ProjectInfo](#PROJECTINFO)

* **project\_id** (string) `Required`
* **name** (string) `Required`
* **project\_type** (ProjectType) `Required`
* **tags** (Struct) `Required`
* **users** (string) `Repeated` `Required`
* **created\_by** (string) `Required`
* **reference\_id** (string) `Required`
* **is\_managed** (bool) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **project\_group\_id** (string) `Required`
* **trusted\_account\_id** (string) `Required`
* **created\_at** (string) `Required`
* **last\_synced\_at** (string) `Required`

{{< highlight json >}} { "project\_id": "project-a1b2c3d4e5f6", "name": "Cloudforet Project", "project\_type": "PUBLIC", "created\_by": "<wonny@cloudforet.io>", "domain\_id": "domain-a1b2c3d4e5f6", "workspace\_id": "workspace-a1b2c3d4e5f6", "created\_at": "2024-11-13T06:35:11.877Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### list

> **POST** /identity/v2/project/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

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

* **query** (Query)
* **project\_id** (string)
* **name** (string)
* **project\_type** (ProjectType)
* **created\_by** (string)
* **include\_children** (bool)
* **workspace\_id** (string)
* **project\_group\_id** (string)
* **user\_id** (string)

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

{{< tab "Response Example" >}}

[ProjectsInfo](#PROJECTSINFO)

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

{{< highlight json >}} { "results": \[ { "created\_at": "2024-11-13T07:01:56.295Z", "created\_by": "<wonny@cloudforet.io>", "domain\_id": "domain-a1b2c3d4e5f6", "name": "Wonny Project", "project\_group\_id": "pg-a1b2c3d4e5f6", "project\_id": "project-a1b2c3d4e5f6", "project\_type": "PRIVATE", "users": \[ "<wonny@cloudforet.io>" ], "workspace\_id": "workspace-a1b2c3d4e5f6" }, { "created\_at": "2024-11-13T06:35:11.877Z", "created\_by": "<cloudforet@cloudforet.io>", "domain\_id": "domain-a1b2c3d4e5f6", "name": "Cloudforet Project", "project\_group\_id": "pg-a1b2c3d4e5f6", "project\_id": "project-g7h8i9j1k2l3", "project\_type": "PRIVATE", "users": \[ "<cloudforet@cloudforet.io>", "<wonny@cloudforet.io>" ], "workspace\_id": "workspace-a1b2c3d4e5f6" } ], "total\_count": 2 } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### stat

> **POST** /identity/v2/project/stat

\ <br>

## Message

### ChangeProjectGroupRequest

* **project\_id** (string) `Required`
* **project\_group\_id** (string) `Required`

  <br>

### CreateProjectRequest

* **name** (string) `Required`
* **project\_type** (ProjectType) `Required`
* **tags** (Struct)
* **project\_group\_id** (string)

  <br>

### ProjectInfo

* **project\_id** (string) `Required`
* **name** (string) `Required`
* **project\_type** (ProjectType) `Required`
* **tags** (Struct) `Required`
* **users** (string) `Repeated` `Required`
* **created\_by** (string) `Required`
* **reference\_id** (string) `Required`
* **is\_managed** (bool) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **project\_group\_id** (string) `Required`
* **trusted\_account\_id** (string) `Required`
* **created\_at** (string) `Required`
* **last\_synced\_at** (string) `Required`

  <br>

### ProjectRequest

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

  <br>

### ProjectSearchQuery

* **query** (Query)
* **project\_id** (string)
* **name** (string)
* **project\_type** (ProjectType)
* **created\_by** (string)
* **include\_children** (bool)
* **workspace\_id** (string)
* **project\_group\_id** (string)
* **user\_id** (string)

  <br>

### ProjectStatQuery

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

  <br>

### ProjectsInfo

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

  <br>

### UpdateProjectRequest

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

  <br>

### UpdateProjectTypeRequest

* **project\_id** (string) `Required`
* **project\_type** (ProjectType) `Required`

  <br>

### UsersProjectRequest

* **project\_id** (string) `Required`
* **users** (string) `Repeated` `Required`

  <br>