Class AccessTokens

Access token authentication of endpoints: the token from the Authorization header, or the deprecated access_token query parameter; requests through the AdminSocket need none and act as a server admin.

Inheritance
object
AccessTokens
Inherited Members
Namespace: Uniform.Matrix.Server.Http
Assembly: Uniform.Matrix.Server.dll
Syntax
public static class AccessTokens

Methods

| Edit this page View Source

GetOwnRequester(HttpContext, string)

Return the requester when it is userId; throw M_FORBIDDEN for other users' data.

Declaration
public static Requester GetOwnRequester(this HttpContext context, string userId)
Parameters
Type Name Description
HttpContext context
string userId
Returns
Type Description
Requester
| Edit this page View Source

GetRequester(HttpContext)

Return the authenticated user of a request behind RequireAccessToken<TBuilder>(TBuilder).

Declaration
public static Requester GetRequester(this HttpContext context)
Parameters
Type Name Description
HttpContext context
Returns
Type Description
Requester
| Edit this page View Source

RejectSuspended<TBuilder>(TBuilder)

Refuse suspended accounts with M_USER_SUSPENDED, for what suspension forbids: sending, joining, inviting, creating rooms, changing the profile and uploading.

Declaration
public static TBuilder RejectSuspended<TBuilder>(this TBuilder builder) where TBuilder : IEndpointConventionBuilder
Parameters
Type Name Description
TBuilder builder
Returns
Type Description
TBuilder
Type Parameters
Name Description
TBuilder
| Edit this page View Source

RequireAccessToken<TBuilder>(TBuilder)

Require a valid access token; the endpoint reads the user with GetRequester(HttpContext).

Declaration
public static TBuilder RequireAccessToken<TBuilder>(this TBuilder builder) where TBuilder : IEndpointConventionBuilder
Parameters
Type Name Description
TBuilder builder
Returns
Type Description
TBuilder
Type Parameters
Name Description
TBuilder
| Edit this page View Source

RequireAdmin<TBuilder>(TBuilder)

Require an access token of a server admin; others get M_FORBIDDEN.

Declaration
public static TBuilder RequireAdmin<TBuilder>(this TBuilder builder) where TBuilder : IEndpointConventionBuilder
Parameters
Type Name Description
TBuilder builder
Returns
Type Description
TBuilder
Type Parameters
Name Description
TBuilder