Mailmus

End users

End User Admin Controller_list

GET
/apps/{appId}/end-users

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Query Parameters

q*string
status*string
provider*string

Response Body

application/json

curl -X GET "https://example.com/apps/string/end-users?q=string&status=string&provider=string"
{  "data": [    {      "id": "string",      "appId": "string",      "email": "string",      "emailVerifiedAt": "2019-08-24T14:15:22Z",      "metadata": {},      "roles": [        "string"      ],      "lastSignInAt": "2019-08-24T14:15:22Z",      "bannedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "mfaEnabledAt": "2019-08-24T14:15:22Z",      "failedSignInAttempts": 0,      "signInLockedUntil": "2019-08-24T14:15:22Z",      "identities": [        {          "provider": "PASSWORD",          "createdAt": "2019-08-24T14:15:22Z"        }      ],      "sessions": [        {          "id": "string",          "userAgent": "string",          "ipAddress": "string",          "createdAt": "2019-08-24T14:15:22Z",          "expiresAt": "2019-08-24T14:15:22Z"        }      ]    }  ],  "total": 0,  "page": 0,  "pages": 0}

End User Admin Controller_stats

GET
/apps/{appId}/end-users/stats

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Response Body

application/json

curl -X GET "https://example.com/apps/string/end-users/stats"
{  "total": 0,  "verified": 0,  "banned": 0,  "mfaEnabled": 0}

End User Admin Controller_export Csv

GET
/apps/{appId}/end-users/export

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Response Body

curl -X GET "https://example.com/apps/string/end-users/export"
Empty

End User Admin Controller_find One

GET
/apps/{appId}/end-users/{id}

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

application/json

curl -X GET "https://example.com/apps/string/end-users/string"
{  "id": "string",  "appId": "string",  "email": "string",  "emailVerifiedAt": "2019-08-24T14:15:22Z",  "metadata": {},  "roles": [    "string"  ],  "lastSignInAt": "2019-08-24T14:15:22Z",  "bannedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "mfaEnabledAt": "2019-08-24T14:15:22Z",  "failedSignInAttempts": 0,  "signInLockedUntil": "2019-08-24T14:15:22Z",  "identities": [    {      "provider": "PASSWORD",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "sessions": [    {      "id": "string",      "userAgent": "string",      "ipAddress": "string",      "createdAt": "2019-08-24T14:15:22Z",      "expiresAt": "2019-08-24T14:15:22Z"    }  ]}

End User Admin Controller_remove

DELETE
/apps/{appId}/end-users/{id}

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

application/json

curl -X DELETE "https://example.com/apps/string/end-users/string"
{  "id": "string",  "appId": "string",  "email": "string",  "emailVerifiedAt": "2019-08-24T14:15:22Z",  "metadata": {},  "roles": [    "string"  ],  "lastSignInAt": "2019-08-24T14:15:22Z",  "bannedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "mfaEnabledAt": "2019-08-24T14:15:22Z",  "failedSignInAttempts": 0,  "signInLockedUntil": "2019-08-24T14:15:22Z",  "identities": [    {      "provider": "PASSWORD",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "sessions": [    {      "id": "string",      "userAgent": "string",      "ipAddress": "string",      "createdAt": "2019-08-24T14:15:22Z",      "expiresAt": "2019-08-24T14:15:22Z"    }  ]}

End User Admin Controller_audit Log

GET
/apps/{appId}/end-users/{id}/audit-log

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X GET "https://example.com/apps/string/end-users/string/audit-log"
Empty

End User Admin Controller_ban

POST
/apps/{appId}/end-users/{id}/ban

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

application/json

curl -X POST "https://example.com/apps/string/end-users/string/ban"
{  "id": "string",  "appId": "string",  "email": "string",  "emailVerifiedAt": "2019-08-24T14:15:22Z",  "metadata": {},  "roles": [    "string"  ],  "lastSignInAt": "2019-08-24T14:15:22Z",  "bannedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "mfaEnabledAt": "2019-08-24T14:15:22Z",  "failedSignInAttempts": 0,  "signInLockedUntil": "2019-08-24T14:15:22Z",  "identities": [    {      "provider": "PASSWORD",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "sessions": [    {      "id": "string",      "userAgent": "string",      "ipAddress": "string",      "createdAt": "2019-08-24T14:15:22Z",      "expiresAt": "2019-08-24T14:15:22Z"    }  ]}

End User Admin Controller_unban

POST
/apps/{appId}/end-users/{id}/unban

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

application/json

curl -X POST "https://example.com/apps/string/end-users/string/unban"
{  "id": "string",  "appId": "string",  "email": "string",  "emailVerifiedAt": "2019-08-24T14:15:22Z",  "metadata": {},  "roles": [    "string"  ],  "lastSignInAt": "2019-08-24T14:15:22Z",  "bannedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "mfaEnabledAt": "2019-08-24T14:15:22Z",  "failedSignInAttempts": 0,  "signInLockedUntil": "2019-08-24T14:15:22Z",  "identities": [    {      "provider": "PASSWORD",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "sessions": [    {      "id": "string",      "userAgent": "string",      "ipAddress": "string",      "createdAt": "2019-08-24T14:15:22Z",      "expiresAt": "2019-08-24T14:15:22Z"    }  ]}

End User Admin Controller_revoke Session

POST
/apps/{appId}/end-users/{id}/sessions/{sessionId}/revoke

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
sessionId*string
appId*string

Response Body

curl -X POST "https://example.com/apps/string/end-users/string/sessions/string/revoke"
Empty

End User Admin Controller_revoke All Sessions

POST
/apps/{appId}/end-users/{id}/sessions/revoke-all

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X POST "https://example.com/apps/string/end-users/string/sessions/revoke-all"
Empty

End User Admin Controller_reset Mfa

POST
/apps/{appId}/end-users/{id}/mfa/reset

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X POST "https://example.com/apps/string/end-users/string/mfa/reset"
Empty

End User Admin Controller_update Metadata

PATCH
/apps/{appId}/end-users/{id}/metadata

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/apps/string/end-users/string/metadata" \  -H "Content-Type: application/json" \  -d '{    "metadata": {      "plan": "pro",      "internalCustomerId": "cus_123"    }  }'
{  "id": "string",  "appId": "string",  "email": "string",  "emailVerifiedAt": "2019-08-24T14:15:22Z",  "metadata": {},  "roles": [    "string"  ],  "lastSignInAt": "2019-08-24T14:15:22Z",  "bannedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "mfaEnabledAt": "2019-08-24T14:15:22Z",  "failedSignInAttempts": 0,  "signInLockedUntil": "2019-08-24T14:15:22Z",  "identities": [    {      "provider": "PASSWORD",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "sessions": [    {      "id": "string",      "userAgent": "string",      "ipAddress": "string",      "createdAt": "2019-08-24T14:15:22Z",      "expiresAt": "2019-08-24T14:15:22Z"    }  ]}

End User Admin Controller_update Roles

PATCH
/apps/{appId}/end-users/{id}/roles

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/apps/string/end-users/string/roles" \  -H "Content-Type: application/json" \  -d '{    "roles": [      "pro",      "beta-tester"    ]  }'
{  "id": "string",  "appId": "string",  "email": "string",  "emailVerifiedAt": "2019-08-24T14:15:22Z",  "metadata": {},  "roles": [    "string"  ],  "lastSignInAt": "2019-08-24T14:15:22Z",  "bannedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "mfaEnabledAt": "2019-08-24T14:15:22Z",  "failedSignInAttempts": 0,  "signInLockedUntil": "2019-08-24T14:15:22Z",  "identities": [    {      "provider": "PASSWORD",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "sessions": [    {      "id": "string",      "userAgent": "string",      "ipAddress": "string",      "createdAt": "2019-08-24T14:15:22Z",      "expiresAt": "2019-08-24T14:15:22Z"    }  ]}