@nebius/js-sdk - v0.2.54
    Preparing search index...

    Interface FederationServiceBaseClient

    Defines the low-level gRPC client for the nebius.iam.v1.FederationService service.

    interface FederationServiceBaseClient {
        activate(
            request: ActivateFederationRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        create(
            request: CreateFederationRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        deactivate(
            request: DeactivateFederationRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        delete(
            request: DeleteFederationRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        get(
            request: GetFederationRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Federation) => void,
        ): SurfaceCall;
        getByName(
            request: GetByNameRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Federation) => void,
        ): SurfaceCall;
        list(
            request: ListFederationsRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (
                error: ServiceError | null,
                response: ListFederationsResponse,
            ) => void,
        ): SurfaceCall;
        update(
            request: UpdateFederationRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
    }

    Hierarchy

    • Client
      • FederationServiceBaseClient
    Index
    activate create deactivate delete get getByName list update

    • Activates an existing federation. By default, a newly created federation is in the active state.

      Parameters

      • request: ActivateFederationRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Activates an existing federation. By default, a newly created federation is in the active state.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Creates a federation.

      Parameters

      • request: CreateFederationRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Creates a federation.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Deactivates an existing federation. When a federation is inactive, all users under it cannot authenticate.

      Parameters

      • request: DeactivateFederationRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Deactivates an existing federation. When a federation is inactive, all users under it cannot authenticate.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Deletes a federation. An active federation cannot be deleted and must be deactivated first.

      Parameters

      • request: DeleteFederationRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Deletes a federation. An active federation cannot be deleted and must be deactivated first.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Retrieves information about a federation by ID.

      Parameters

      • request: GetFederationRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Federation) => void
          • (error: ServiceError | null, response: Federation): void

          • Retrieves information about a federation by ID.

            Parameters

            Returns void

      Returns SurfaceCall

    • Retrieves information about a federation by name and parent container.

      Parameters

      • request: GetByNameRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Federation) => void
          • (error: ServiceError | null, response: Federation): void

          • Retrieves information about a federation by name and parent container.

            Parameters

            Returns void

      Returns SurfaceCall

    • Lists federations by parent container.

      Parameters

      Returns SurfaceCall

    • Updates a federation.

      Parameters

      • request: UpdateFederationRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Updates a federation.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    Settings
    Member Visibility

    On This Page
    Methods