Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

OAUTH Application API, gRPC: ApplicationService.Suspend

Written by
Updated at October 3, 2025

Sets status to SUSPENDED for the specified OAuth application.

gRPC request

rpc Suspend (SuspendApplicationRequest) returns (operation.Operation)

SuspendApplicationRequest

{
  "application_id": "string"
}

Request to suspend a OAuth application.

Field

Description

application_id

string

Required field. ID of the OAuth application to suspend.
To get the OAuth application ID, make a ApplicationService.List request.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "application_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "name": "string",
    "organization_id": "string",
    "description": "string",
    "group_claims_settings": {
      "group_distribution_type": "GroupDistributionType"
    },
    "client_grant": {
      "client_id": "string",
      "authorized_scopes": [
        "string"
      ]
    },
    "status": "Status",
    "labels": "map<string, string>",
    "created_at": "google.protobuf.Timestamp",
    "updated_at": "google.protobuf.Timestamp"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

SuspendApplicationMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Application

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

SuspendApplicationMetadata

Metadata for the ApplicationService.Suspend operation.

Field

Description

application_id

string

ID of the OAuth application that is being suspended.

Application

An OAuth application resource.

Field

Description

id

string

ID of the application.

name

string

Name of the application.
The name is unique within the organization. 3-63 characters long.

organization_id

string

ID of the organization that the application belongs to.

description

string

Description of the application. 0-256 characters long.

group_claims_settings

GroupClaimsSettings

Settings of the group claims

client_grant

ClientGrant

Represents current connection to the OAuth client with specified scopes

status

enum Status

Current status of the application.

  • STATUS_UNSPECIFIED: The status is not specified.
  • CREATING: The apllication is in the process of being created.
  • ACTIVE: The apllication is active and operational.
  • SUSPENDED: The apllication is suspended. I.e. authentication via this application is disabled.
  • DELETING: The apllication is in the process of being deleted.

labels

object (map<string, string>)

Resource labels as key:value pairs.

created_at

google.protobuf.Timestamp

Creation timestamp.

updated_at

google.protobuf.Timestamp

Modification timestamp.

GroupClaimsSettings

Settings of the group claims

Field

Description

group_distribution_type

enum GroupDistributionType

Represents current distribution type of the groups. I.e. which groups are visible for the application users.

  • GROUP_DISTRIBUTION_TYPE_UNSPECIFIED: The distribution type is unspecified
  • NONE: No groups are visible for the application users
  • ASSIGNED_GROUPS: Only assigned groups are visible for the application users
  • ALL_GROUPS: All groups are visible for the application users

ClientGrant

Represents connection to the OAuth client with specified scopes

Field

Description

client_id

string

Required field. OAuth client id

authorized_scopes[]

string

List of authorized client scopes by the application
Previous
Update
Next
Reactivate