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

SAML Application API, gRPC: ApplicationService.UpdateAssignments

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

Updates assignments for the specified SAML application.

gRPC request

rpc UpdateAssignments (UpdateAssignmentsRequest) returns (operation.Operation)

UpdateAssignmentsRequest

{
  "application_id": "string",
  "assignment_deltas": [
    {
      "action": "AssignmentAction",
      "assignment": {
        "subject_id": "string"
      }
    }
  ]
}

Request to update assignments for a SAML application.

Field

Description

application_id

string

Required field. ID of the SAML application to update assignments for.

assignment_deltas[]

AssignmentDelta

List of assignment deltas to apply.

AssignmentDelta

A delta operation on assignments.

Field

Description

action

enum AssignmentAction

Required field. Action to perform on the assignment.

  • ASSIGNMENT_ACTION_UNSPECIFIED: The assignment action is not specified.
  • ADD: Add an assignment.
  • REMOVE: Remove an assignment.

assignment

Assignment

Required field. Assignment to perform the action on.

Assignment

An assignment for a SAML application.

Field

Description

subject_id

string

Required field. ID of the subject being assigned.

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": {
    "assignment_deltas": [
      {
        "action": "AssignmentAction",
        "assignment": {
          "subject_id": "string"
        }
      }
    ]
  }
  // 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

UpdateAssignmentsMetadata

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

UpdateAssignmentsResponse

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.

UpdateAssignmentsMetadata

Metadata for the ApplicationService.UpdateAssignments operation.

Field

Description

application_id

string

ID of the SAML application whose assignments are being updated.

UpdateAssignmentsResponse

Response message for ApplicationService.UpdateAssignments.

Field

Description

assignment_deltas[]

AssignmentDelta

List of assignment deltas that were applied.

AssignmentDelta

A delta operation on assignments.

Field

Description

action

enum AssignmentAction

Required field. Action to perform on the assignment.

  • ASSIGNMENT_ACTION_UNSPECIFIED: The assignment action is not specified.
  • ADD: Add an assignment.
  • REMOVE: Remove an assignment.

assignment

Assignment

Required field. Assignment to perform the action on.

Assignment

An assignment for a SAML application.

Field

Description

subject_id

string

Required field. ID of the subject being assigned.
Предыдущая
ListAssignments
Следующая
Overview