Contact UsGet started
© 2024 Iron Hive LLC Belgrade

SAML Federation API, gRPC: FederationService.DeleteUserAccounts

Written by
Updated at November 7, 2024

Deletes users from the specified federation.

gRPC request

rpc DeleteUserAccounts (DeleteFederatedUserAccountsRequest) returns (operation.Operation)

DeleteFederatedUserAccountsRequest

{
  "federationId": "string",
  "subjectIds": [
    "string"
  ]
}

Field

Description

federationId

string

Required field. ID of the federation to delete users from.

subjectIds[]

string

List of subjects to delete.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "federationId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "deletedSubjects": [
      "string"
    ],
    "nonExistingSubjects": [
      "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.

createdAt

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

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

modifiedAt

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

DeleteFederatedUserAccountsMetadata

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

DeleteFederatedUserAccountsResponse

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.

DeleteFederatedUserAccountsMetadata

Field

Description

federationId

string

ID of the federation that is being altered.

DeleteFederatedUserAccountsResponse

Field

Description

deletedSubjects[]

string

List of subjects deleted by FederationService.DeleteUserAccounts request.

nonExistingSubjects[]

string

List of subjects found in FederationService.DeleteUserAccounts request that do not exist.
Previous
AddUserAccounts
Next
ListUserAccounts