> 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/project-group.md). # Project Group > **Package : spaceone.api.identity.v1** ## ProjectGroup {% hint style="info" %} **ProjectGroup Methods:** {% endhint %} | Method | Request | Response | | ------------------------------------ | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | | [**create**](#create) | [CreateProjectGroupRequest](#createprojectgrouprequest) | [ProjectGroupInfo](#projectgroupinfo) | | [**update**](#update) | [UpdateProjectGroupRequest](#updateprojectgrouprequest) | [ProjectGroupInfo](#projectgroupinfo) | | [**delete**](#delete) | [ProjectGroupRequest](#projectgrouprequest) | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) | | [**get**](#get) | [GetProjectGroupRequest](#getprojectgrouprequest) | [ProjectGroupInfo](#projectgroupinfo) | | [**list**](#list) | [ProjectGroupQuery](#projectgroupquery) | [ProjectGroupsInfo](#projectgroupsinfo) | | [**stat**](#stat) | [ProjectGroupStatQuery](#projectgroupstatquery) | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | | [**add\_member**](#add_member) | [AddProjectGroupMemberRequest](#addprojectgroupmemberrequest) | [ProjectGroupRoleBindingInfo](#projectgrouprolebindinginfo) | | [**modify\_member**](#modify_member) | [ModifyProjectGroupMemberRequest](#modifyprojectgroupmemberrequest) | [ProjectGroupRoleBindingInfo](#projectgrouprolebindinginfo) | | [**remove\_member**](#remove_member) | [RemoveProjectGroupMemberRequest](#removeprojectgroupmemberrequest) | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) | | [**list\_members**](#list_members) | [ProjectGroupMemberQuery](#projectgroupmemberquery) | [ProjectGroupRoleBindingsInfo](#projectgrouprolebindingsinfo) | | [**list\_projects**](#list_projects) | [ProjectGroupProjectQuery](#projectgroupprojectquery) | [ProjectGroupProjectsInfo](#projectgroupprojectsinfo) | ### create > **POST** /identity/v1/project-groups | Type | Message | | -------- | ------------------------------------------------------- | | Request | [CreateProjectGroupRequest](#createprojectgrouprequest) | | Response | [ProjectGroupInfo](#projectgroupinfo) | ### update > **PUT** /identity/v1/project-group/{project\_group\_id} | Type | Message | | -------- | ------------------------------------------------------- | | Request | [UpdateProjectGroupRequest](#updateprojectgrouprequest) | | Response | [ProjectGroupInfo](#projectgroupinfo) | ### delete > **DELETE** /identity/v1/project-group/{project\_id} | Type | Message | | -------- | ---------------------------------------------------------------------------------------------------------------- | | Request | [ProjectGroupRequest](#projectgrouprequest) | | Response | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) | ### get > **GET** /identity/v1/project-group/{project\_group\_id} | Type | Message | | -------- | ------------------------------------------------- | | Request | [GetProjectGroupRequest](#getprojectgrouprequest) | | Response | [ProjectGroupInfo](#projectgroupinfo) | ### list > **GET** /identity/v1/project-groups > > **POST** /identity/v1/project-groups/search | Type | Message | | -------- | --------------------------------------- | | Request | [ProjectGroupQuery](#projectgroupquery) | | Response | [ProjectGroupsInfo](#projectgroupsinfo) | ### stat > **POST** /identity/v1/project-groups/stat | Type | Message | | -------- | ------------------------------------------------------------------------------------------------------------------ | | Request | [ProjectGroupStatQuery](#projectgroupstatquery) | | Response | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | ### add\_member > **POST** /identity/v1/project-group/{project\_group\_id}/members | Type | Message | | -------- | ------------------------------------------------------------- | | Request | [AddProjectGroupMemberRequest](#addprojectgroupmemberrequest) | | Response | [ProjectGroupRoleBindingInfo](#projectgrouprolebindinginfo) | ### modify\_member > **PUT** /identity/v1/project-group/{project\_group\_id}/member/{user\_id} | Type | Message | | -------- | ------------------------------------------------------------------- | | Request | [ModifyProjectGroupMemberRequest](#modifyprojectgroupmemberrequest) | | Response | [ProjectGroupRoleBindingInfo](#projectgrouprolebindinginfo) | ### remove\_member > **DELETE** /identity/v1/project-group/{project\_group\_id}/member/{user\_id} | Type | Message | | -------- | ---------------------------------------------------------------------------------------------------------------- | | Request | [RemoveProjectGroupMemberRequest](#removeprojectgroupmemberrequest) | | Response | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) | ### list\_members > **GET** /identity/v1/project-group/{project\_group\_id}/members > > **POST** /identity/v1/project-group/{project\_id}/members/search | Type | Message | | -------- | ------------------------------------------------------------- | | Request | [ProjectGroupMemberQuery](#projectgroupmemberquery) | | Response | [ProjectGroupRoleBindingsInfo](#projectgrouprolebindingsinfo) | ### list\_projects > **GET** /identity/v1/project-group/{project\_group\_id}/projects > > **POST** /identity/v1/project-group/{project\_id}/projects/search | Type | Message | | -------- | ----------------------------------------------------- | | Request | [ProjectGroupProjectQuery](#projectgroupprojectquery) | | Response | [ProjectGroupProjectsInfo](#projectgroupprojectsinfo) | ## ## Message ### AddProjectGroupMemberRequest | Field | Type | Required | Description | | ------------------ | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- | | project\_group\_id | string | ✔ | | | user\_id | string | ✔ | | | role\_id | string | ✘ | | | labels | [google.protobuf.ListValue](https://developers.google.com/protocol-buffers/docs/reference/overview) | ✘ | | | tags | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | ✘ | | | domain\_id | string | ✔ | | | is\_external\_user | bool | ✘ | | ### CreateProjectGroupRequest | Field | Type | Required | Description | | -------------------------- | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- | | name | string | ✔ | | | parent\_project\_group\_id | string | ✘ | | | tags | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | ✘ | | | domain\_id | string | ✔ | | ### GetProjectGroupRequest | Field | Type | Required | Description | | ------------------ | -------------- | :------: | ----------- | | project\_group\_id | string | ✔ | | | domain\_id | string | ✔ | | | only | list of string | ✘ | | ### ModifyProjectGroupMemberRequest | Field | Type | Required | Description | | ------------------ | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- | | project\_group\_id | string | ✔ | | | user\_id | string | ✔ | | | labels | [google.protobuf.ListValue](https://developers.google.com/protocol-buffers/docs/reference/overview) | ✘ | | | tags | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | ✘ | | | domain\_id | string | ✔ | | ### ProjectGroupInfo | Field | Type | Description | | ---------------------------- | ------------------------------------------------------------------------------------------------------------------ | ----------- | | project\_group\_id | string | | | name | string | | | tags | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | | | parent\_project\_group\_info | [ProjectGroupInfo](#projectgroupinfo) | | | domain\_id | string | | | created\_by | string | | | created\_at | string | | ### ProjectGroupMemberQuery | Field | Type | Required | Description | | ----------------------- | -------------------------------------------------------------------------------------------------- | :------: | ----------- | | query | [spaceone.api.core.v1.Query](https://spaceone-dev.gitbook.io/api-reference/common-v1/search-query) | ✘ | | | project\_group\_id | string | ✔ | | | user\_id | string | ✘ | | | role\_id | string | ✘ | | | include\_parent\_member | bool | ✘ | | | domain\_id | string | ✔ | | ### ProjectGroupProjectInfo | Field | Type | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------------ | ----------- | | project\_id | string | | | name | string | | | tags | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | | | project\_group\_info | [ProjectGroupInfo](#projectgroupinfo) | | | domain\_id | string | | | created\_by | string | | | created\_at | string | | ### ProjectGroupProjectQuery | Field | Type | Required | Description | | ------------------ | -------------------------------------------------------------------------------------------------- | :------: | ----------- | | query | [spaceone.api.core.v1.Query](https://spaceone-dev.gitbook.io/api-reference/common-v1/search-query) | ✘ | | | project\_group\_id | string | ✔ | | | recursive | bool | ✘ | | | domain\_id | string | ✔ | | ### ProjectGroupProjectsInfo | Field | Type | Description | | ------------ | ----------------------------------------------------------------------------------------------- | ----------- | | results | [list of ProjectGroupProjectInfo](#projectgroupprojectinfo) | | | total\_count | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) | | ### ProjectGroupQuery | Field | Type | Required | Description | | -------------------------- | -------------------------------------------------------------------------------------------------- | :------: | ----------- | | query | [spaceone.api.core.v1.Query](https://spaceone-dev.gitbook.io/api-reference/common-v1/search-query) | ✘ | | | project\_group\_id | string | ✘ | | | name | string | ✘ | | | parent\_project\_group\_id | string | ✘ | | | author\_within | bool | ✘ | | | domain\_id | string | ✔ | | ### ProjectGroupRequest | Field | Type | Required | Description | | ------------------ | ------ | :------: | ----------- | | project\_group\_id | string | ✔ | | | domain\_id | string | ✔ | | ### ProjectGroupRoleBindingInfo | Field | Type | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------------ | ----------- | | role\_binding\_id | string | | | resource\_type | string | | | resource\_id | string | | | role\_info | [RoleInfo](#roleinfo) | | | project\_group\_info | [ProjectGroupInfo](#projectgroupinfo) | | | labels | [google.protobuf.ListValue](https://developers.google.com/protocol-buffers/docs/reference/overview) | | | tags | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | | | domain\_id | string | | | created\_at | string | | ### ProjectGroupRoleBindingsInfo | Field | Type | Description | | ------------ | ----------------------------------------------------------------------------------------------- | ----------- | | results | [list of ProjectGroupRoleBindingInfo](#projectgrouprolebindinginfo) | | | total\_count | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) | | ### ProjectGroupStatQuery | Field | Type | Required | Description | | ---------- | ---------------------------------------------------------------------------------------------------------------- | :------: | ----------- | | query | [spaceone.api.core.v1.StatisticsQuery](https://spaceone-dev.gitbook.io/api-reference/common-v1/statistics-query) | ✔ | | | domain\_id | string | ✔ | | ### ProjectGroupsInfo | Field | Type | Description | | ------------ | ----------------------------------------------------------------------------------------------- | ----------- | | results | [list of ProjectGroupInfo](#projectgroupinfo) | | | total\_count | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) | | ### RemoveProjectGroupMemberRequest | Field | Type | Required | Description | | ------------------ | ------ | :------: | ----------- | | project\_group\_id | string | ✔ | | | user\_id | string | ✔ | | | domain\_id | string | ✔ | | ### UpdateProjectGroupRequest | Field | Type | Required | Description | | ------------------------------- | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- | | project\_group\_id | string | ✔ | | | name | string | ✘ | | | parent\_project\_group\_id | string | ✘ | | | release\_parent\_project\_group | bool | ✘ | | | tags | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | ✘ | | | domain\_id | string | ✔ | |