Связаться с намиПодключиться

SAML Application API, gRPC: SignatureCertificateService.Update

Статья создана
Обновлена 30 октября 2025 г.

Updates the specified signature certificate.

gRPC request

rpc Update (UpdateSignatureCertificateRequest) returns (operation.Operation)

UpdateSignatureCertificateRequest

{
  "signature_certificate_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string"
}

Request to update an existing signature certificate.

Field

Description

signature_certificate_id

string

Required field. ID of the signature certificate to update.

update_mask

google.protobuf.FieldMask

Field mask that specifies which fields of the certificate are going to be updated.

name

string

New name for the signature certificate.

description

string

New description for the signature certificate.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "signature_certificate_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "application_id": "string",
    "status": "Status",
    "name": "string",
    "description": "string",
    "created_at": "google.protobuf.Timestamp",
    "data": "string",
    "fingerprint": "string",
    "not_after": "google.protobuf.Timestamp",
    "not_before": "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

UpdateSignatureCertificateMetadata

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

SignatureCertificate

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.

UpdateSignatureCertificateMetadata

Metadata for the SignatureCertificateService.Update operation.

Field

Description

signature_certificate_id

string

ID of the signature certificate that is being updated.

SignatureCertificate

A signature certificate for SAML applications.

Field

Description

id

string

Unique identifier of the signature certificate.

application_id

string

ID of the SAML application that the signature certificate belongs to.

status

enum Status

Current status of the signature certificate.

  • STATUS_UNSPECIFIED: The status is not specified.
  • ACTIVE: The certificate is active and can be used for signing.
  • INACTIVE: The certificate is inactive and cannot be used for signing.

name

string

Name of the signature certificate.

description

string

Description of the signature certificate.

created_at

google.protobuf.Timestamp

Creation timestamp.

data

string

Certificate data in PEM format.

fingerprint

string

SHA256-fingerprint of the signature certificate.

not_after

google.protobuf.Timestamp

Time after which the signature certificate is not valid.

not_before

google.protobuf.Timestamp

Time before which the signature certificate is not valid.
Предыдущая
Create
Следующая
Delete