# One-Time Login

Login users using one-time login methods like magic links or OTPs. This implements a frontend integration for authentication, where the client obtains an authorization code that your app can exchange in the backend for user tokens.


## Servers

Sandbox environment
```
https://api.sbx.transmitsecurity.io/cis
```

US production environment
```
https://api.transmitsecurity.io/cis
```

EU production environment
```
https://api.eu.transmitsecurity.io/cis
```

CA production environment
```
https://api.ca.transmitsecurity.io/cis
```

AU production environment
```
https://api.au.transmitsecurity.io/cis
```

JP production environment
```
https://api.gasne1-ts01.transmitsecurity.io/cis
```

## Security

### bearer

Type: http
Scheme: bearer
Bearer Format: JWT

### UserAccessToken

A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated

Type: http
Scheme: bearer
Bearer Format: JWT

### AdminAccessToken

[object Object]

Type: oauth2
Token URL: /oidc/token
Scopes:

### ClientAccessToken

[object Object]

Type: oauth2
Token URL: /oidc/token
Scopes:

### OrgAdminAccessToken

A token returned upon B2B authentication for a user that has the organizationAdmin or organizationCreator role.

Type: oauth2
Token URL: /oidc/token
Scopes:

## Download OpenAPI description

 - [One-Time Login](https://developer.transmitsecurity.com/_bundle/openapi/user/one-time-login.openapi.yaml)

 - [POST /v1/auth/links/email](https://developer.transmitsecurity.com/openapi/user/one-time-login.openapi/other/sendemail.md): Send a magic link by email to a user. <br><br>**Required permissions**: `apps:execute`, `[appId]:execute`, `auth:execute`.
 - [POST /v1/auth/otp/email](https://developer.transmitsecurity.com/openapi/user/one-time-login.openapi/other/sendemailotp.md): Send a one-time passcode (OTP) by email to the given email address. <br><br>**Required permissions**: `apps:execute`, `[appId]:execute`, `auth:execute`.
 - [POST /v1/auth/otp/email/validation](https://developer.transmitsecurity.com/openapi/user/one-time-login.openapi/other/validateemailotp.md): Validate a one-time passcode sent by email to a user. The endpoint will return a URI which can be used to redirect the client in order to complete authentication. <br><br>**Required permissions**: `ap
 - [POST /v1/auth/otp/sms](https://developer.transmitsecurity.com/openapi/user/one-time-login.openapi/other/sendsmsotp.md): Send a one-time passcode (OTP) by SMS to the given phone number. <br><br>**Required permissions**: `apps:execute`, `[appId]:execute`, `auth:execute`.
 - [POST /v1/auth/otp/sms/validation](https://developer.transmitsecurity.com/openapi/user/one-time-login.openapi/other/validatesms.md): Validate a one-time passcode sent by SMS to a user. The endpoint will return a URI which can be used to redirect the client in order to complete authentication. <br><br>**Required permissions**: `apps
 - [POST /v1/auth/logout](https://developer.transmitsecurity.com/openapi/user/one-time-login.openapi/other/logout.md): Logout the user from a specific session. The user and session are derived from the access token used to authorize the request (which was issued based on the authentication that created the session)
 - [POST /v1/token](https://developer.transmitsecurity.com/openapi/user/one-time-login.openapi/other/tokenexchange.md): Retrieve ID and access tokens. This API is used to retrieve ID and access tokens using the code that was returned in the redirect URI as a query parameter (for example, when the user clicks a magic li