Generic authorization API

How to get a token, expire of Nothing means some default value (server config).

Logic of authorisation via this method is:

• Client sends GET request to the endpoint with user specified login and password and optional expire
• Server responds with token or error
• Client uses the token with other requests as authorisation header
• Client can extend lifetime of token by periodically pinging of AuthTouchMethod endpoint
• Client can invalidate token instantly by AuthSignoutMethod
• Client can get info about user with AuthTokenInfoMethod endpoint.

How to get a token, expire of Nothing means some default value (server config).

Logic of authorisation via this method is:

• Client sends POST request to the endpoint with user specified login and password and optional expire
• Server responds with token or error
• Client uses the token with other requests as authorisation header
• Client can extend lifetime of token by periodically pinging of AuthTouchMethod endpoint
• Client can invalidate token instantly by AuthSignoutMethod
• Client can get info about user with AuthTokenInfoMethod endpoint.

Authorisation via code of single usage.

Logic of authorisation via this method is:

• Client sends GET request to AuthSigninGetCodeMethod endpoint
• Server generates single use token and sends it via SMS or email (server specific implementation)
• Client sends POST request to AuthSigninPostCodeMethod endpoint
• Server responds with auth token.
• Client uses the token with other requests as authorisation header
• Client can extend lifetime of token by periodically pinging of AuthTouchMethod endpoint
• Client can invalidate token instantly by AuthSignoutMethod
• Client can get info about user with AuthTokenInfoMethod endpoint.

Authorisation via code of single usage.

Logic of authorisation via this method is:

• Client sends GET request to AuthSigninGetCodeMethod endpoint
• Server generates single use token and sends it via SMS or email (server specific implementation)
• Client sends POST request to AuthSigninPostCodeMethod endpoint
• Server responds with auth token.
• Client uses the token with other requests as authorisation header
• Client can extend lifetime of token by periodically pinging of AuthTouchMethod endpoint
• Client can invalidate token instantly by AuthSignoutMethod
• Client can get info about user with AuthTokenInfoMethod endpoint.

Client cat expand the token lifetime, no permissions are required

Get client info that is binded to the token

Close session, after call of the method the token in header is not valid.

Creation of new user, requires registerPerm for token

Getting list of all users, requires authInfoPerm for token

Getting info about user, requires authInfoPerm for token

Updating loginemailpassword, requires authUpdatePerm for token

Replace user with the user in the body, requires authUpdatePerm for token

Delete user from DB, requires authDeletePerm and will cause cascade deletion, that is your usually want

Generate new password for user. There is two phases, first, the method is called without code parameter. The system sends email with a restore code to user email or sms (its depends on server). After that a call of the method with the code is needed to change password.

Generate single usage codes that user can write down and use later for emergency authorisation.

Nothing for "codes-count" parameter means some default value defined by server. Server can restrict maximum count of such codes.

Server should invalidate previous codes on subsequent calls of the endpoint.

Special authorisation tag can be used to disable the feature, merely don't give the tag to users and they won't be able to generate codes.

See also: AuthSigninPostCodeMethod for utilisation of the codes.

Getting info about user group, requires authInfoPerm for token

Inserting new user group, requires authUpdatePerm for token

Replace info about given user group, requires authUpdatePerm for token

Patch info about given user group, requires authUpdatePerm for token

Delete all info about given user group, requires authDeletePerm for token

Get list of user groups, requires authInfoPerm for token

Check permissions of the token, if the passed token doesn't have permissions that are passed via body, server returns False. 401 status is returned if the token owner is not permitted to check self permissions.

Get the user id of the owner of specified token. 401 error is raised if the token doesn't have 'auth-userid' token.

Proxy type for auth API, used to pass the type-level info into client/docs generation functions

Servant.Docs documentation of the Auth API

Type level permission type that allows to construct complex permission labels

Convertation of permission symbol into runtim string

Unlifting compile-time permissions into list of run-time permissions

Helper type family to wrap all symbols into PermLabel

Token is simple string marked by permissions that are expected from the token to pass guarding functions.

Token is simple string marked by permissions that are expected from the token to pass guarding functions.

Simplified version that takes plain symbols as permissions.

Shortcut for Maybe Token with attached permissions

Shortcut for Maybe Token with attached permissions

Simplified version that takes plain symbols as permissions.

Token header that we require for authorization marked by permissions that are expected from the token to pass guarding functions.

Token header that we require for authorization marked by permissions that are expected from the token to pass guarding functions.

Simplified version that takes plain symbols as permissions.

Token that doesn't have attached compile-time permissions

Cast token to permissions that are lower than original one

The cast is safe, the permissions are cheked on compile time.

Cast token to permissions that are lower than original one.

The cast is safe, the permissions are cheked on compile time.

Id of user that is used in the API

User name for login

Password for login

User email

Special tag for a permission that a user has

Amount of seconds

Special tag for password restore

Single use code used for authorisation via AuthSigninGetCodeMethod and AuthSigninPostCodeMethod endpoints

Request body for user registration

Response with user info

Request body for patching user

Response with users info and pagination

Body for AuthSigninPostMethod

Id of user group

Data of user group, groups allows to group permissions and assign them to particular users in batch manner.

Also a group hierarchy can be formed.

Data type that is used to patch UserGroup

Permission that allows everything by default

Permission that allows to check permissions of token that has the permission.

Permission that allows to delete users and cause cascade deletion

Permission that allows to query info about other users

Permission that allows to update fields of an user

Permission that allows to get user ID of owner of token.

Permission that allows registration of new users

Select only operations of the Auth API