User credentials

User credentials authentication is currently required for:

• Switching between Workspaces
• Transferring SIMs between Workspaces

Authenticate with user credentials

To authenticate, send a POST request to /api/v1/authenticate with your username (your email address) and a SHA-1 hashed password. The response includes an auth_token and refresh_token.

1
import requests
2
3
url = "https://cdn.emnify.net/api/v1/authenticate"
4
5
payload = {
6
    "username": "user@service.org",
7
    "password": "8Y8knYSkeyYV23kd"
8
}
9
headers = {"Content-Type": "application/json"}
10
11
response = requests.post(url, json=payload, headers=headers)
12
13
print(response.json())

1
{
2
  "auth_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
3
  "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
4
}

Hash your password with SHA-1

The API requires your password to be SHA-1 hashed before sending. This is a legacy requirement for compatibility with existing integrations.

To generate a SHA-1 hash in your terminal:

$
echo -n 'your_password' | openssl sha1

Refresh your auth token

After successful authentication, the server returns both an auth_token and a refresh_token. Use the refresh token to obtain a new auth_token without re-entering your credentials.

1
import requests
2
3
url = "https://cdn.emnify.net/api/v1/authenticate"
4
5
payload = { "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." }
6
headers = {"Content-Type": "application/json"}
7
8
response = requests.post(url, json=payload, headers=headers)
9
10
print(response.json())

1
{
2
  "auth_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
3
}

Token expiration

Handle expired tokens

When your auth_token expires:

1. If your refresh_token is still valid, use it to get a new auth_token
2. If both tokens have expired, authenticate again with your username and password

To avoid interruptions, refresh your token before it expires. Consider refreshing when the auth_token has less than 30 minutes remaining.