# One-Time Login

Login users using one-time login methods like magic links or OTPs. This implements a backend-to-backend integration for authentication.


## Servers

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

Production environment (US)
```
https://api.transmitsecurity.io/cis
```

Production environment (EU)
```
https://api.eu.transmitsecurity.io/cis
```

Production environment (CA)
```
https://api.ca.transmitsecurity.io/cis
```

Production environment (AU)
```
https://api.au.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

A token generated by a management application using the [token endpoint](/openapi/token.openapi/other/getaccesstoken). It provides access to all resources for the tenant and its apps

Type: oauth2

### ClientAccessToken

A token generated by an end-user application using the [token endpoint](/openapi/token.openapi/other/getaccesstoken). It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)

Type: oauth2

### OrgAdminAccessToken

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

Type: oauth2

## Download OpenAPI description

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

## Other

### Send email link

 - [POST /v1/auth/link/email/send](https://developer.transmitsecurity.com/openapi/user/backend-one-time-login.openapi/other/sendmagiclinkemail.md): Send a magic link by email to a user. Upon clicking the email link, the User Agent will be redirected to the requested redirect URI with a code (passed in the code query parameter). This code can be used to complete the authentication in the subsequent request.

### Authenticate email link

 - [POST /v1/auth/link/email/authenticate](https://developer.transmitsecurity.com/openapi/user/backend-one-time-login.openapi/other/authenticatemagiclink.md): Authenticate a user using the email magic link you sent them. Upon clicking the email link, a code was returned to your redirect URI as the code query parameter. This API validates this code and returns user tokens.

### Send OTP

 - [POST /v1/auth/otp/send](https://developer.transmitsecurity.com/openapi/user/backend-one-time-login.openapi/other/sendotp.md): Send a one-time passcode to a user by email or SMS, or retrieve the code directly in the response to deliver it out-of-band — for example, when an admin generates a temporary access code on behalf of a user.

### Authenticate OTP

 - [POST /v1/auth/otp/authenticate](https://developer.transmitsecurity.com/openapi/user/backend-one-time-login.openapi/other/authenticateotp.md): Authenticates a user using a one-time passcode that was sent to them by email or SMS. This API validates the code provided by the user and returns user tokens.