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

# ProjectGroup

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

\ <br>

## ProjectGroup

**ProjectGroup Methods:**

| Method                                                                                                                                              | Request                                                                                                                                                   | Response                                                                                                                                  |
| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| [**create**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#create)                             | [CreateProjectGroupRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#createprojectgrouprequest) | [ProjectGroupInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#projectgroupinfo)   |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#update)                             | [UpdateProjectGroupRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#updateprojectgrouprequest) | [ProjectGroupInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#projectgroupinfo)   |
| [**change\_parent\_group**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#change_parent_group) | [ChangeParentGroupRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#changeparentgrouprequest)   | [ProjectGroupInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#projectgroupinfo)   |
| [**delete**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#delete)                             | [ProjectGroupRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#projectgrouprequest)             | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#empty)                         |
| [**add\_users**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#add_users)                      | [UsersProjectGroupRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#usersprojectgrouprequest)   | [ProjectGroupInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#projectgroupinfo)   |
| [**remove\_users**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#remove_users)                | [UsersProjectGroupRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#usersprojectgrouprequest)   | [ProjectGroupInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#projectgroupinfo)   |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#get)                                   | [ProjectGroupRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#projectgrouprequest)             | [ProjectGroupInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#projectgroupinfo)   |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#list)                                 | [ProjectGroupSearchQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#projectgroupsearchquery)     | [ProjectGroupsInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#projectgroupsinfo) |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#stat)                                 | [ProjectGroupStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#projectgroupstatquery)         | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/ProjectGroup/README.md#struct)                       |

<br>

### create

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

{{< tabs " create " >}}

{{< tab "Request Example" >}}

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

* **name** (string) `Required`
* **tags** (Struct)
* **parent\_group\_id** (string)

{{< highlight json >}} { "name": "Cloudforet Company", "tags": { } } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[ProjectGroupInfo](#PROJECTGROUPINFO)

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

{{< highlight json >}} { "project\_group\_id": "pg-7120aabb662c", "name": "Cloudforet Core Team", "tags": {}, "domain\_id": "domain-186446b1516b", "workspace\_id": "workspace-1a02ebcb3eb2", "parent\_group\_id": "pg-10efea238292", "created\_at": "2024-07-12T03:31:02.222Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### update

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

{{< tabs " update " >}}

{{< tab "Request Example" >}}

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

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

{{< highlight json >}} { "project\_group\_id": "pg-7120aabb662c", "name": "Cloudforet Core Team" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[ProjectGroupInfo](#PROJECTGROUPINFO)

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

{{< highlight json >}} { "project\_group\_id": "pg-7120aabb662c", "name": "Cloudforet Core Team", "tags": {}, "domain\_id": "domain-186446b1516b", "workspace\_id": "workspace-1a02ebcb3eb2", "parent\_group\_id": "pg-10efea238292", "created\_at": "2024-07-12T03:31:02.222Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### change\_parent\_group

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

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

{{< tab "Request Example" >}}

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

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

{{< highlight json >}} { "project\_group\_id": "pg-7120aabb662c", "parent\_group\_id": "pg-10efea238292" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[ProjectGroupInfo](#PROJECTGROUPINFO)

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

{{< highlight json >}} { "project\_group\_id": "pg-7120aabb662c", "name": "Cloudforet Core Team", "tags": {}, "domain\_id": "domain-186446b1516b", "workspace\_id": "workspace-1a02ebcb3eb2", "parent\_group\_id": "pg-10efea238292", "created\_at": "2024-07-12T03:31:02.222Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### delete

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

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

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

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

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

{{< /tabs >}}

<br>

### add\_users

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

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

{{< tab "Request Example" >}}

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

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

{{< highlight json >}} { "project\_group\_id": "pg-7120aabb662c", "users": \["<wonny@cloudforet.io>", "<bolby@cloudforet.io>"] } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[ProjectGroupInfo](#PROJECTGROUPINFO)

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

{{< highlight json >}} { "project\_group\_id": "pg-7120aabb662c", "name": "Cloudforet Core Team", "tags": {}, "domain\_id": "domain-186446b1516b", "workspace\_id": "workspace-1a02ebcb3eb2", "parent\_group\_id": "pg-10efea238292", "created\_at": "2024-07-12T03:31:02.222Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### remove\_users

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

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

{{< tab "Request Example" >}}

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

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

{{< highlight json >}} { "project\_group\_id": "pg-7120aabb662c", "users": \["<wonny@cloudforet.io>", "<bolby@cloudforet.io>"] } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[ProjectGroupInfo](#PROJECTGROUPINFO)

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

{{< highlight json >}} { "project\_group\_id": "pg-7120aabb662c", "name": "Cloudforet Core Team", "tags": {}, "domain\_id": "domain-186446b1516b", "workspace\_id": "workspace-1a02ebcb3eb2", "parent\_group\_id": "pg-10efea238292", "created\_at": "2024-07-12T03:31:02.222Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### get

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

{{< tabs " get " >}}

{{< tab "Request Example" >}}

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

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

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

{{< tab "Response Example" >}}

[ProjectGroupInfo](#PROJECTGROUPINFO)

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

{{< highlight json >}} { "project\_group\_id": "pg-7120aabb662c", "name": "Cloudforet Core Team", "tags": {}, "domain\_id": "domain-186446b1516b", "workspace\_id": "workspace-1a02ebcb3eb2", "parent\_group\_id": "pg-10efea238292", "created\_at": "2024-07-12T03:31:02.222Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### list

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

{{< tabs " list " >}}

{{< tab "Request Example" >}}

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

* **query** (Query)
* **project\_group\_id** (string)
* **name** (string)
* **workspace\_id** (string)
* **parent\_group\_id** (string)

{{< highlight json >}} { "query": { "page": { "start":1, "limit":10 } } } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[ProjectGroupsInfo](#PROJECTGROUPSINFO)

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

{{< highlight json >}} { "results": \[ { "project\_group\_id": "pg-7120aabb662c", "name": "Cloudforet Core Team", "tags": {}, "domain\_id": "domain-186446b1516b", "workspace\_id": "workspace-1a02ebcb3eb2", "parent\_group\_id": "pg-10efea238292", "created\_at": "2024-07-12T03:31:02.222Z" } ], "total\_count": 1 } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### stat

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

\ <br>

## Message

### ChangeParentGroupRequest

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

  <br>

### CreateProjectGroupRequest

* **name** (string) `Required`
* **tags** (Struct)
* **parent\_group\_id** (string)

  <br>

### ProjectGroupInfo

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

  <br>

### ProjectGroupRequest

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

  <br>

### ProjectGroupSearchQuery

* **query** (Query)
* **project\_group\_id** (string)
* **name** (string)
* **workspace\_id** (string)
* **parent\_group\_id** (string)

  <br>

### ProjectGroupStatQuery

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

  <br>

### ProjectGroupsInfo

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

  <br>

### UpdateProjectGroupRequest

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

  <br>

### UsersProjectGroupRequest

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

  <br>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://cloudforet.gitbook.io/cloudforet-apis/content/en/identity/v2/projectgroup.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
