class documentation

class FederationServiceServicer(object): (source)

View In Hierarchy

Missing associated documentation comment in .proto file.

Method Activate Activates an existing federation. By default, a newly created federation is in the active state.
Method Create Creates a federation.
Method Deactivate Deactivates an existing federation. When a federation is inactive, all users under it cannot authenticate.
Method Delete Deletes a federation. An active federation cannot be deleted and must be deactivated first.
Method Get Retrieves information about a federation by ID.
Method GetByName Retrieves information about a federation by name and parent container.
Method List Lists federations by parent container.
Method Update Updates a federation.
def Activate(self, request, context): (source)

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

def Create(self, request, context): (source)

Creates a federation.

def Deactivate(self, request, context): (source)

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

def Delete(self, request, context): (source)

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

def Get(self, request, context): (source)

Retrieves information about a federation by ID.

def GetByName(self, request, context): (source)

Retrieves information about a federation by name and parent container.

def List(self, request, context): (source)

Lists federations by parent container.

def Update(self, request, context): (source)

Updates a federation.