Class FederatedCredentialsService

constructor

• new FederatedCredentialsService(sdk: SDKInterface): FederatedCredentialsService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns FederatedCredentialsService

$type

create

• create(
      request: CreateFederatedCredentialsRequest,
  ): Request<
      CreateFederatedCredentialsRequest,
      Operation<GetOperationRequest>,
  >

  Creates federated credentials.

  Parameters

  • request: CreateFederatedCredentialsRequest

  Returns Request<CreateFederatedCredentialsRequest, Operation<GetOperationRequest>>

• create(
      request: CreateFederatedCredentialsRequest,
      metadata: Metadata,
  ): Request<
      CreateFederatedCredentialsRequest,
      Operation<GetOperationRequest>,
  >

  Creates federated credentials.

  Parameters

  • request: CreateFederatedCredentialsRequest
  • metadata: Metadata

  Returns Request<CreateFederatedCredentialsRequest, Operation<GetOperationRequest>>

• create(
      request: CreateFederatedCredentialsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<
      CreateFederatedCredentialsRequest,
      Operation<GetOperationRequest>,
  >

  Creates federated credentials.

  Parameters

  • request: CreateFederatedCredentialsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateFederatedCredentialsRequest, Operation<GetOperationRequest>>

• create(
      request: CreateFederatedCredentialsRequest,
  ): Request<
      CreateFederatedCredentialsRequest,
      Operation<GetOperationRequest>,
  >

  Creates federated credentials.

  Parameters

  • request: CreateFederatedCredentialsRequest

  Returns Request<CreateFederatedCredentialsRequest, Operation<GetOperationRequest>>

• create(
      request: CreateFederatedCredentialsRequest,
      metadata: Metadata,
  ): Request<
      CreateFederatedCredentialsRequest,
      Operation<GetOperationRequest>,
  >

  Creates federated credentials.

  Parameters

  • request: CreateFederatedCredentialsRequest
  • metadata: Metadata

  Returns Request<CreateFederatedCredentialsRequest, Operation<GetOperationRequest>>

• create(
      request: CreateFederatedCredentialsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<
      CreateFederatedCredentialsRequest,
      Operation<GetOperationRequest>,
  >

  Creates federated credentials.

  Parameters

  • request: CreateFederatedCredentialsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateFederatedCredentialsRequest, Operation<GetOperationRequest>>

delete

• delete(
      request: DeleteFederatedCredentialsRequest,
  ): Request<
      DeleteFederatedCredentialsRequest,
      Operation<GetOperationRequest>,
  >

  Deletes federated credentials.

  Parameters

  • request: DeleteFederatedCredentialsRequest

  Returns Request<DeleteFederatedCredentialsRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteFederatedCredentialsRequest,
      metadata: Metadata,
  ): Request<
      DeleteFederatedCredentialsRequest,
      Operation<GetOperationRequest>,
  >

  Deletes federated credentials.

  Parameters

  • request: DeleteFederatedCredentialsRequest
  • metadata: Metadata

  Returns Request<DeleteFederatedCredentialsRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteFederatedCredentialsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<
      DeleteFederatedCredentialsRequest,
      Operation<GetOperationRequest>,
  >

  Deletes federated credentials.

  Parameters

  • request: DeleteFederatedCredentialsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteFederatedCredentialsRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteFederatedCredentialsRequest,
  ): Request<
      DeleteFederatedCredentialsRequest,
      Operation<GetOperationRequest>,
  >

  Deletes federated credentials.

  Parameters

  • request: DeleteFederatedCredentialsRequest

  Returns Request<DeleteFederatedCredentialsRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteFederatedCredentialsRequest,
      metadata: Metadata,
  ): Request<
      DeleteFederatedCredentialsRequest,
      Operation<GetOperationRequest>,
  >

  Deletes federated credentials.

  Parameters

  • request: DeleteFederatedCredentialsRequest
  • metadata: Metadata

  Returns Request<DeleteFederatedCredentialsRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteFederatedCredentialsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<
      DeleteFederatedCredentialsRequest,
      Operation<GetOperationRequest>,
  >

  Deletes federated credentials.

  Parameters

  • request: DeleteFederatedCredentialsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteFederatedCredentialsRequest, Operation<GetOperationRequest>>

filter

• filter(
      request: ListFederatedCredentialsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<FederatedCredentials>

  Calls the filter method.

  Parameters

  • request: ListFederatedCredentialsRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<FederatedCredentials>

• filter(
      request: ListFederatedCredentialsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<FederatedCredentials>

  Yields list items across pages, without changing the supplied request.

  Parameters

  • request: ListFederatedCredentialsRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<FederatedCredentials>

get

• get(
      request: GetFederatedCredentialsRequest,
  ): Request<GetFederatedCredentialsRequest, FederatedCredentials>

  Retrieves information about federated credentials by ID.

  Parameters

  • request: GetFederatedCredentialsRequest

  Returns Request<GetFederatedCredentialsRequest, FederatedCredentials>

• get(
      request: GetFederatedCredentialsRequest,
      metadata: Metadata,
  ): Request<GetFederatedCredentialsRequest, FederatedCredentials>

  Retrieves information about federated credentials by ID.

  Parameters

  • request: GetFederatedCredentialsRequest
  • metadata: Metadata

  Returns Request<GetFederatedCredentialsRequest, FederatedCredentials>

• get(
      request: GetFederatedCredentialsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetFederatedCredentialsRequest, FederatedCredentials>

  Retrieves information about federated credentials by ID.

  Parameters

  • request: GetFederatedCredentialsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetFederatedCredentialsRequest, FederatedCredentials>

• get(
      request: GetFederatedCredentialsRequest,
  ): Request<GetFederatedCredentialsRequest, FederatedCredentials>

  Retrieves information about federated credentials by ID.

  Parameters

  • request: GetFederatedCredentialsRequest

  Returns Request<GetFederatedCredentialsRequest, FederatedCredentials>

• get(
      request: GetFederatedCredentialsRequest,
      metadata: Metadata,
  ): Request<GetFederatedCredentialsRequest, FederatedCredentials>

  Retrieves information about federated credentials by ID.

  Parameters

  • request: GetFederatedCredentialsRequest
  • metadata: Metadata

  Returns Request<GetFederatedCredentialsRequest, FederatedCredentials>

• get(
      request: GetFederatedCredentialsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetFederatedCredentialsRequest, FederatedCredentials>

  Retrieves information about federated credentials by ID.

  Parameters

  • request: GetFederatedCredentialsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetFederatedCredentialsRequest, FederatedCredentials>

getByName

• getByName(
      request: GetByNameFederatedCredentialsRequest,
  ): Request<GetByNameFederatedCredentialsRequest, FederatedCredentials>

  Retrieves information about federated credentials by name and parent container.

  Parameters

  • request: GetByNameFederatedCredentialsRequest

  Returns Request<GetByNameFederatedCredentialsRequest, FederatedCredentials>

• getByName(
      request: GetByNameFederatedCredentialsRequest,
      metadata: Metadata,
  ): Request<GetByNameFederatedCredentialsRequest, FederatedCredentials>

  Retrieves information about federated credentials by name and parent container.

  Parameters

  • request: GetByNameFederatedCredentialsRequest
  • metadata: Metadata

  Returns Request<GetByNameFederatedCredentialsRequest, FederatedCredentials>

• getByName(
      request: GetByNameFederatedCredentialsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetByNameFederatedCredentialsRequest, FederatedCredentials>

  Retrieves information about federated credentials by name and parent container.

  Parameters

  • request: GetByNameFederatedCredentialsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetByNameFederatedCredentialsRequest, FederatedCredentials>

• getByName(
      request: GetByNameFederatedCredentialsRequest,
  ): Request<GetByNameFederatedCredentialsRequest, FederatedCredentials>

  Retrieves information about federated credentials by name and parent container.

  Parameters

  • request: GetByNameFederatedCredentialsRequest

  Returns Request<GetByNameFederatedCredentialsRequest, FederatedCredentials>

• getByName(
      request: GetByNameFederatedCredentialsRequest,
      metadata: Metadata,
  ): Request<GetByNameFederatedCredentialsRequest, FederatedCredentials>

  Retrieves information about federated credentials by name and parent container.

  Parameters

  • request: GetByNameFederatedCredentialsRequest
  • metadata: Metadata

  Returns Request<GetByNameFederatedCredentialsRequest, FederatedCredentials>

• getByName(
      request: GetByNameFederatedCredentialsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetByNameFederatedCredentialsRequest, FederatedCredentials>

  Retrieves information about federated credentials by name and parent container.

  Parameters

  • request: GetByNameFederatedCredentialsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetByNameFederatedCredentialsRequest, FederatedCredentials>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListFederatedCredentialsRequest,
  ): Request<
      ListFederatedCredentialsRequest,
      ListFederatedCredentialsResponse,
  >

  Lists federated credentials by parent container.

  Parameters

  • request: ListFederatedCredentialsRequest

  Returns Request<ListFederatedCredentialsRequest, ListFederatedCredentialsResponse>

• list(
      request: ListFederatedCredentialsRequest,
      metadata: Metadata,
  ): Request<
      ListFederatedCredentialsRequest,
      ListFederatedCredentialsResponse,
  >

  Lists federated credentials by parent container.

  Parameters

  • request: ListFederatedCredentialsRequest
  • metadata: Metadata

  Returns Request<ListFederatedCredentialsRequest, ListFederatedCredentialsResponse>

• list(
      request: ListFederatedCredentialsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<
      ListFederatedCredentialsRequest,
      ListFederatedCredentialsResponse,
  >

  Lists federated credentials by parent container.

  Parameters

  • request: ListFederatedCredentialsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListFederatedCredentialsRequest, ListFederatedCredentialsResponse>

• list(
      request: ListFederatedCredentialsRequest,
  ): Request<
      ListFederatedCredentialsRequest,
      ListFederatedCredentialsResponse,
  >

  Lists federated credentials by parent container.

  Parameters

  • request: ListFederatedCredentialsRequest

  Returns Request<ListFederatedCredentialsRequest, ListFederatedCredentialsResponse>

• list(
      request: ListFederatedCredentialsRequest,
      metadata: Metadata,
  ): Request<
      ListFederatedCredentialsRequest,
      ListFederatedCredentialsResponse,
  >

  Lists federated credentials by parent container.

  Parameters

  • request: ListFederatedCredentialsRequest
  • metadata: Metadata

  Returns Request<ListFederatedCredentialsRequest, ListFederatedCredentialsResponse>

• list(
      request: ListFederatedCredentialsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<
      ListFederatedCredentialsRequest,
      ListFederatedCredentialsResponse,
  >

  Lists federated credentials by parent container.

  Parameters

  • request: ListFederatedCredentialsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListFederatedCredentialsRequest, ListFederatedCredentialsResponse>

listOperations

• listOperations(
      request: ListOperationsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): Request<ListOperationsRequest>

  Lists operations for this service address.

  Parameters

  • request: ListOperationsRequest
  • metadata: Metadata = ...
  • options: Partial<CallOptions> & RetryOptions = {}

  Returns Request<ListOperationsRequest>

update

• update(
      request: UpdateFederatedCredentialsRequest,
  ): Request<
      UpdateFederatedCredentialsRequest,
      Operation<GetOperationRequest>,
  >

  Updates federated credentials.

  Parameters

  • request: UpdateFederatedCredentialsRequest

  Returns Request<UpdateFederatedCredentialsRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateFederatedCredentialsRequest,
      metadata: Metadata,
  ): Request<
      UpdateFederatedCredentialsRequest,
      Operation<GetOperationRequest>,
  >

  Updates federated credentials.

  Parameters

  • request: UpdateFederatedCredentialsRequest
  • metadata: Metadata

  Returns Request<UpdateFederatedCredentialsRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateFederatedCredentialsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<
      UpdateFederatedCredentialsRequest,
      Operation<GetOperationRequest>,
  >

  Updates federated credentials.

  Parameters

  • request: UpdateFederatedCredentialsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateFederatedCredentialsRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateFederatedCredentialsRequest,
  ): Request<
      UpdateFederatedCredentialsRequest,
      Operation<GetOperationRequest>,
  >

  Updates federated credentials.

  Parameters

  • request: UpdateFederatedCredentialsRequest

  Returns Request<UpdateFederatedCredentialsRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateFederatedCredentialsRequest,
      metadata: Metadata,
  ): Request<
      UpdateFederatedCredentialsRequest,
      Operation<GetOperationRequest>,
  >

  Updates federated credentials.

  Parameters

  • request: UpdateFederatedCredentialsRequest
  • metadata: Metadata

  Returns Request<UpdateFederatedCredentialsRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateFederatedCredentialsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<
      UpdateFederatedCredentialsRequest,
      Operation<GetOperationRequest>,
  >

  Updates federated credentials.

  Parameters

  • request: UpdateFederatedCredentialsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateFederatedCredentialsRequest, Operation<GetOperationRequest>>