V2Alpha1.PlayerAuthService.PlayerAuthServiceBase Class

Namespace: Improbable.SpatialOS.PlayerAuth

Base class for server-side implementations of PlayerAuthService


Methods

CreateLoginToken
global::System.Threading.Tasks.Task<global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.CreateLoginTokenResponse> CreateLoginToken(global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.CreateLoginTokenRequest request, grpc::ServerCallContext context)

Creates a LoginToken (LT) for a given user, project and deployment.

Returns:
The response to send back to the client (wrapped by a task).

Parameters
  • global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.CreateLoginTokenRequest request : The request received from the client.
  • grpc::ServerCallContext context : The context of the server-side call handler being invoked.

Notes:
  • This grants the user access to a given deployment.

CreatePlayerIdentityToken
global::System.Threading.Tasks.Task<global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.CreatePlayerIdentityTokenResponse> CreatePlayerIdentityToken(global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.CreatePlayerIdentityTokenRequest request, grpc::ServerCallContext context)

Creates a PlayerIdentityToken (PIT) for a given user and project.

Returns:
The response to send back to the client (wrapped by a task).

Parameters
  • global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.CreatePlayerIdentityTokenRequest request : The request received from the client.
  • grpc::ServerCallContext context : The context of the server-side call handler being invoked.

Notes:
  • This identifies players in the context of a project and provider.
  • Invalid fields result in an InvalidArgument error. See the CreatePlayerIdentityTokenRequest message for details of what is valid for each field.

DecodePlayerIdentityToken
global::System.Threading.Tasks.Task<global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.DecodePlayerIdentityTokenResponse> DecodePlayerIdentityToken(global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.DecodePlayerIdentityTokenRequest request, grpc::ServerCallContext context)

Decodes a PlayerIdentityToken (PIT).

Returns:
The response to send back to the client (wrapped by a task).

Parameters
  • global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.DecodePlayerIdentityTokenRequest request : The request received from the client.
  • grpc::ServerCallContext context : The context of the server-side call handler being invoked.

Notes:
  • Tokens that cannot be verified result in an InvalidArgument error.

CreateDevelopmentAuthenticationToken
global::System.Threading.Tasks.Task<global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.CreateDevelopmentAuthenticationTokenResponse> CreateDevelopmentAuthenticationToken(global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.CreateDevelopmentAuthenticationTokenRequest request, grpc::ServerCallContext context)

Creates a DevelopmentAuthenticationToken (DAT) for a given project.

Returns:
The response to send back to the client (wrapped by a task).

Parameters
  • global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.CreateDevelopmentAuthenticationTokenRequest request : The request received from the client.
  • grpc::ServerCallContext context : The context of the server-side call handler being invoked.

GetDevelopmentAuthenticationToken
global::System.Threading.Tasks.Task<global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.GetDevelopmentAuthenticationTokenResponse> GetDevelopmentAuthenticationToken(global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.GetDevelopmentAuthenticationTokenRequest request, grpc::ServerCallContext context)

Get a DAT given its ID.

Returns:
The response to send back to the client (wrapped by a task).

Parameters
  • global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.GetDevelopmentAuthenticationTokenRequest request : The request received from the client.
  • grpc::ServerCallContext context : The context of the server-side call handler being invoked.

Notes:
  • This endpoint returns a NotFound error in case the DAT could not be found.

ListDevelopmentAuthenticationTokens
global::System.Threading.Tasks.Task<global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.ListDevelopmentAuthenticationTokensResponse> ListDevelopmentAuthenticationTokens(global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.ListDevelopmentAuthenticationTokensRequest request, grpc::ServerCallContext context)

Lists DATs associated with a project.

Returns:
The response to send back to the client (wrapped by a task).

Parameters
  • global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.ListDevelopmentAuthenticationTokensRequest request : The request received from the client.
  • grpc::ServerCallContext context : The context of the server-side call handler being invoked.

UpdateDevelopmentAuthenticationToken
global::System.Threading.Tasks.Task<global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.UpdateDevelopmentAuthenticationTokenResponse> UpdateDevelopmentAuthenticationToken(global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.UpdateDevelopmentAuthenticationTokenRequest request, grpc::ServerCallContext context)

Updates the description and the validity period of a DAT.

Returns:
The response to send back to the client (wrapped by a task).

Parameters
  • global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.UpdateDevelopmentAuthenticationTokenRequest request : The request received from the client.
  • grpc::ServerCallContext context : The context of the server-side call handler being invoked.

Notes:
  • You can use this endpoint to both extend the validity period of valid DATs and renew expired DATs.

ExpireDevelopmentAuthenticationToken
global::System.Threading.Tasks.Task<global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.ExpireDevelopmentAuthenticationTokenResponse> ExpireDevelopmentAuthenticationToken(global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.ExpireDevelopmentAuthenticationTokenRequest request, grpc::ServerCallContext context)

Immediately expires a DAT thereby revoking its validity.

Returns:
The response to send back to the client (wrapped by a task).

Parameters
  • global::Improbable.SpatialOS.PlayerAuth.V2Alpha1.ExpireDevelopmentAuthenticationTokenRequest request : The request received from the client.
  • grpc::ServerCallContext context : The context of the server-side call handler being invoked.

Notes:
  • You can undo this operation by extending the lifetime of an expired DAT using the UpdateDevelopmentAuthenticationToken endpoint. Expired DATs are permanently deleted after one week.

Updated about a year ago


V2Alpha1.PlayerAuthService.PlayerAuthServiceBase Class


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.