# InStore_Auth

The InStore\_Auth module provides functionality to authenticate users and authorize their access to InStore features based on assigned roles.

## Capabilities

The InStore\_Auth module handles the following InStore functions:

- Receives data from the [InStore\_State](/instore/implement-instore/modules/instore-state.md) module about an external source of retailer-managed users and saves it to the browser storage.
- Receives credentials (username and password), or a PIN associated with each user.
- Initializes and persists session data after a user is authenticated.
- Registers a [role](/instore/use-the-instore-center/store-roles.md) for each user.

  You can manage [roles and permissions](/instore/use-the-instore-center/store-roles.md) in the InStore Center.

## GitHub location

The source code for the InStore\_Auth module is available on [GitHub](https://github.com/NebulaTerra/modular-store/tree/main/InStore_Auth).

## Administration parameters

You can modify the behavior of this module by setting the following [administration parameters](/instore/customization/administration-parameters.md) in the InStore Center:

### Store Front parameters

- `Enable_Soft_Login_with_PIN`
- `Mask_Soft_Login_PIN`

## Access the InStore POS

You manage your own access to the InStore POS and can access it by using a custom URL that has the following format:

`{host site}/{environment label}/{location ID}/{workstation ID}`

For easy access, program this URL into each workstation's locked browser. When a user logs in, the app claims that workstation for their session.

## User interface

This module affects the login screen on the InStore POS UI.

## Authentication error codes

If there is a problem with authentication, you may receive one of the following error codes:

| Code | Message |
| --- | --- |
| 9000 | Tenant environment not found |
| 9001 | Location not found |
| 9002 | Workstation not found |
| 9003 | Workstation already claimed |
| 9009 | Timeout |
| 9010 | Server error |

## Related pages

- [Search documentation and API specs](/search.md)