Project

Package : spaceone.api.identity.v2

Project

Project Methods:

MethodRequestResponse

create

CreateProjectRequest

ProjectInfo

update

UpdateProjectRequest

ProjectInfo

update_project_type

UpdateProjectTypeRequest

ProjectInfo

change_project_group

ChangeProjectGroupRequest

ProjectInfo

delete

ProjectRequest

Empty

add_users

UsersProjectRequest

ProjectInfo

remove_users

UsersProjectRequest

ProjectInfo

get

ProjectRequest

ProjectInfo

list

ProjectSearchQuery

ProjectsInfo

stat

ProjectStatQuery

Struct

create

POST /identity/v2/project/create

{{< tabs " create " >}}

{{< tab "Request Example" >}}

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

  • 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 >}}

update

POST /identity/v2/project/update

{{< tabs " update " >}}

{{< tab "Request Example" >}}

UpdateProjectRequest

  • project_id (string) Required

  • name (string)

  • tags (Struct)

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

{{< tab "Response Example" >}}

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 >}}

update_project_type

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

{{< tabs " update_project_type " >}}

{{< tab "Request Example" >}}

UpdateProjectTypeRequest

  • project_id (string) Required

  • project_type (ProjectType) Required

{{< highlight json >}} { "project_id": "project-a1b2c3d4e5f6", "project_type": "PRIVATE" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

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 >}}

change_project_group

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

{{< tabs " change_project_group " >}}

{{< tab "Request Example" >}}

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

  • 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 >}}

delete

POST /identity/v2/project/delete

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

ProjectRequest

  • project_id (string) Required

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

{{< /tabs >}}

add_users

POST /identity/v2/project/add-users

{{< tabs " add_users " >}}

{{< tab "Request Example" >}}

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

  • 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 >}}

remove_users

POST /identity/v2/project/remove-users

{{< tabs " remove_users " >}}

{{< tab "Request Example" >}}

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

  • 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 >}}

get

POST /identity/v2/project/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

ProjectRequest

  • project_id (string) Required

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

{{< tab "Response Example" >}}

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 >}}

list

POST /identity/v2/project/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

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

  • 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 >}}

stat

POST /identity/v2/project/stat

Message

ChangeProjectGroupRequest

  • project_id (string) Required

  • project_group_id (string) Required

CreateProjectRequest

  • name (string) Required

  • project_type (ProjectType) Required

  • tags (Struct)

  • project_group_id (string)

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

ProjectRequest

  • project_id (string) Required

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)

ProjectStatQuery

  • query (StatisticsQuery) Required

ProjectsInfo

  • results (ProjectInfo) Repeated Required

  • total_count (int32) Required

UpdateProjectRequest

  • project_id (string) Required

  • name (string)

  • tags (Struct)

UpdateProjectTypeRequest

  • project_id (string) Required

  • project_type (ProjectType) Required

UsersProjectRequest

  • project_id (string) Required

  • users (string) Repeated Required

PreviousPolicyNextProjectGroup

Last updated