Interface IPlayerAuthenticationAdminApi

Represents a collection of functions to interact with the API endpoints

Inherited Members

IApiAccessor.Configuration

IApiAccessor.GetBasePath()

Namespace: Unity.Services.Apis.Admin.PlayerAuthentication

Assembly: Unity.Services.Apis.dll

Syntax

public interface IPlayerAuthenticationAdminApi : IApiAccessor

Methods

ChangePassword(string, string, PlayerAuthChangePasswordRequest, CancellationToken)

Change Password

Declaration

ApiOperation ChangePassword(string playerId, string projectId, PlayerAuthChangePasswordRequest playerAuthChangePasswordRequest = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	playerId	This is the player Id.
string	projectId	Id of the project.
PlayerAuthChangePasswordRequest	playerAuthChangePasswordRequest	(optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

DeletePlayer(string, string, CancellationToken)

Delete Player

Declaration

ApiOperation<object> DeletePlayer(string playerId, string projectId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	playerId	This is the player Id.
string	projectId	Id of the project.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<object>	The operation

DisablePlayer(string, string, CancellationToken)

Disable Player

Declaration

ApiOperation<PlayerAuthPlayerProjectResponse> DisablePlayer(string playerId, string projectId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	playerId	This is the player Id.
string	projectId	Id of the project.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<PlayerAuthPlayerProjectResponse>	The operation

EnablePlayer(string, string, CancellationToken)

Enable Player

Declaration

ApiOperation<PlayerAuthPlayerProjectResponse> EnablePlayer(string playerId, string projectId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	playerId	This is the player Id.
string	projectId	Id of the project.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<PlayerAuthPlayerProjectResponse>	The operation

GetPlayer(string, string, CancellationToken)

Get Player

Declaration

ApiOperation<PlayerAuthPlayerProjectResponse> GetPlayer(string playerId, string projectId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	playerId	This is the player Id.
string	projectId	Id of the project.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<PlayerAuthPlayerProjectResponse>	The operation

ListPlayers(string, int?, string, string, string, string, CancellationToken)

List Players

Declaration

ApiOperation<PlayerAuthListProjectUserResponse> ListPlayers(string projectId, int? limit = null, string page = null, string username = null, string externalId = null, string idProvider = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	Id of the project.
int?	limit	The number of players to return. (optional)
string	page	(Optional) The next page token. If not set, returns players without any offset. (optional)
string	username	Username of the player. (optional)
string	externalId	External Provider player id. (optional)
string	idProvider	External provider name among the supported ones. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<PlayerAuthListProjectUserResponse>	The operation