Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Suspend Group

POST
/taxonomy/v1/organisations/{organisation}/groups/{id}:suspend
 
curl --request POST \
  --url https://example.com/taxonomy/v1/organisations/example/groups/example:suspend \
  --header 'Content-Type: application/json' \
  --data '{ "organisation": "example", "id": "example" }'

Freezes a group: mutations are rejected and its running resources are stopped, while all data is retained. Reversible via :resume. Platform administrators only.

Custom methods use body: "*" per AIP-136. Path parameters are extracted from the URL; any future non-path fields are deserialized from the HTTP body.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
organisation
required
string

The organisation the group belongs to

id
required
string

The unique identifier of the group to suspend

Request Body required

Section titled “Request Body required ”
Media type application/json

SuspendGroupRequest

Request message for SuspendGroup. Identifies the group to suspend.

object
organisation
required

The organisation the group belongs to

string
id
required

The unique identifier of the group to suspend

string
Example generated
{
  "organisation": "example",
  "id": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Taxonomy Operation

An acknowledgment of a mutation request, carrying tracking metadata, errors, and warnings. Follows GCP’s Operations pattern (AIP-151).

object
id

Operation ID

Unique identifier for this operation.

stringOutput only
resource_id

Resource ID

The ID of the resource affected by this operation. May be empty for async operations where the resource does not yet exist.

stringOutput only
resource_type

Resource Type

The type of resource (e.g., “com.qibdo.cloud.taxonomy:group”).

stringOutput only
operation_type

Operation Type

The kind of mutation that was requested.

string format: enum Output only
Allowed values: TAXONOMY_OPERATION_TYPE_UNSPECIFIED TAXONOMY_OPERATION_TYPE_CREATE TAXONOMY_OPERATION_TYPE_UPDATE TAXONOMY_OPERATION_TYPE_DELETE TAXONOMY_OPERATION_TYPE_MOVE TAXONOMY_OPERATION_TYPE_SUSPEND TAXONOMY_OPERATION_TYPE_RESUME TAXONOMY_OPERATION_TYPE_ARCHIVE TAXONOMY_OPERATION_TYPE_RESTORE
status

Status

Current lifecycle state of the operation.

string format: enum Output only
Allowed values: TAXONOMY_OPERATION_STATUS_UNSPECIFIED TAXONOMY_OPERATION_STATUS_PENDING TAXONOMY_OPERATION_STATUS_RUNNING TAXONOMY_OPERATION_STATUS_DONE TAXONOMY_OPERATION_STATUS_ERROR
insert_time

Insert Time

When the operation was first created.

string format: date-time Output only
start_time

Start Time

When the operation started executing.

string format: date-time Output only
end_time

End Time

When the operation completed (either successfully or with errors).

string format: date-time Output only
errors

Errors

Business rule errors encountered during the operation.

Array<object>Output only

Operation Error

A structured error returned inside an operation when a business rule fails.

object
code

Error Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only
description

Description

Human-readable explanation of the error.

stringOutput only
reason

Reason

Machine-readable error identifier in UPPER_SNAKE form — the same dispatch key google.rpc.ErrorInfo.reason carries on the synchronous error plane.

stringOutput only
warnings

Warnings

Non-fatal notices about the operation.

Array<object>Output only

Operation Warning

A non-fatal notice attached to an operation.

object
code

Warning Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only
description

Description

Human-readable explanation of the warning.

stringOutput only
progress

Progress

Percentage of completion (0-100).

integer format: int32 Output only
scope_type

Scope Type

The category of scope the operation ran in or was triggered from. TAXONOMY_SCOPE_TYPE_UNSPECIFIED when the operation is not scoped.

string format: enum Output only
Allowed values: TAXONOMY_SCOPE_TYPE_UNSPECIFIED TAXONOMY_SCOPE_TYPE_PLATFORM TAXONOMY_SCOPE_TYPE_ORGANISATION TAXONOMY_SCOPE_TYPE_WORKSPACE TAXONOMY_SCOPE_TYPE_GROUP
scope_id

Scope ID

The resource this operation was scoped to — for example, when scope_type is TAXONOMY_SCOPE_TYPE_WORKSPACE this is the workspace id. Empty for TAXONOMY_SCOPE_TYPE_PLATFORM, which has no scoped resource, and when unscoped.

stringOutput only
principal_id

Principal ID

Who performed or triggered the operation, whether a person or a machine account. Always populated: platform-driven work records the reserved system principal, so every audit record names an actor.

stringOutput only
trace_id

Trace ID

W3C trace id, for correlating this operation with the traces and log lines of the request that caused it. Empty when the operation ran with no trace context — a scheduled or event-driven action rather than a request.

stringOutput only
origin

Origin

Whether this operation was a direct action or a change cascaded from an ancestor’s suspend or resume.

string format: enum Output only
Allowed values: TAXONOMY_STATE_CHANGE_ORIGIN_UNSPECIFIED TAXONOMY_STATE_CHANGE_ORIGIN_DIRECT TAXONOMY_STATE_CHANGE_ORIGIN_INDIRECT
caused_by_operation_id

Caused By Operation

For a cascaded (indirect) operation, the id of the direct operation that triggered the cascade. Empty for direct operations.

stringOutput only
Example 
{
  "operation_type": "TAXONOMY_OPERATION_TYPE_UNSPECIFIED",
  "status": "TAXONOMY_OPERATION_STATUS_UNSPECIFIED",
  "scope_type": "TAXONOMY_SCOPE_TYPE_UNSPECIFIED",
  "origin": "TAXONOMY_STATE_CHANGE_ORIGIN_UNSPECIFIED"
}

default

Section titled “default ”

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}