{ "info": { "_postman_id": "076f33c6-904d-4f1b-b07c-3088e39e11f6", "name": "One-Time Login Applications Users API", "description": "Login users using one-time login methods like magic links or OTPs. This implements a backend-to-backend integration for authentication.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "lastUpdatedBy": "35240", "uid": "35240-076f33c6-904d-4f1b-b07c-3088e39e11f6" }, "item": [ { "name": "v1", "item": [ { "name": "users", "item": [ { "name": "count", "item": [ { "name": "Get users count", "id": "33e7cb48-0568-40c7-bf9d-e687ea05e17a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/count?search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "count" ], "query": [ { "description": "Search expression based on the [SCIM protocol](https://www.rfc-editor.org/rfc/rfc7644#section-3.4.2.2). For syntax and searchable fields, see [Search query syntax](/openapi/scim_search_syntax/)", "key": "search", "value": "" } ] }, "description": "Get the number of saved users.

**Required permissions**: `users:list`, `apps:list`, `[appId]:list`." }, "response": [ { "id": "3c8daa55-9ec3-4f84-8fe7-217d8c7b0a60", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/count?search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "count" ], "query": [ { "description": "Search expression based on the [SCIM protocol](https://www.rfc-editor.org/rfc/rfc7644#section-3.4.2.2). For syntax and searchable fields, see [Search query syntax](/openapi/scim_search_syntax/)", "key": "search", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": {\n \"user_count\": \"\"\n }\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-3c8daa55-9ec3-4f84-8fe7-217d8c7b0a60" }, { "id": "1121fbdd-a2a9-495b-9a7c-4e4753dec4fa", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/count?search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "count" ], "query": [ { "description": "Search expression based on the [SCIM protocol](https://www.rfc-editor.org/rfc/rfc7644#section-3.4.2.2). For syntax and searchable fields, see [Search query syntax](/openapi/scim_search_syntax/)", "key": "search", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": [\n \"\",\n \"\"\n ],\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-1121fbdd-a2a9-495b-9a7c-4e4753dec4fa" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-33e7cb48-0568-40c7-bf9d-e687ea05e17a" } ], "id": "537978da-3655-4dfa-98f8-129e4b1ec381", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-537978da-3655-4dfa-98f8-129e4b1ec381" }, { "name": "identifier", "item": [ { "name": "Get user by identifier", "id": "900224af-4067-4606-aed8-eb570d47ce02", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/identifier?identifier_name=&identifier_value=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "identifier" ], "query": [ { "description": "(Required) Identifier name: one of the built-ins (email, phoneNumber, externalUserId, username, idpIdentifier) or a tenant-defined custom identifier", "key": "identifier_name", "value": "" }, { "description": "(Required) Identifier value", "key": "identifier_value", "value": "" } ] }, "description": "Search for a user by identifier.

**Required permissions**: `apps:read`, `[appId]:read`, `users:read`." }, "response": [ { "id": "956f7fbe-cfbf-4b06-a1cf-7483a71b6f94", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/identifier?identifier_name=&identifier_value=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "identifier" ], "query": [ { "description": "(Required) Identifier name: one of the built-ins (email, phoneNumber, externalUserId, username, idpIdentifier) or a tenant-defined custom identifier", "key": "identifier_name", "value": "" }, { "description": "(Required) Identifier value", "key": "identifier_value", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": {\n \"user_id\": \"\",\n \"status\": \"Disabled\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_emails\": [\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"phone_number\": {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_phone_numbers\": [\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"username\": \"\",\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Other\",\n \"updated_at\": \"\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"status_changed_at\": \"\",\n \"identity_providers\": [\n {\n \"source\": \"SMS OTP\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n },\n {\n \"source\": \"BindIDApi\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n }\n ],\n \"identities\": [\n {\n \"provider_name\": \"\",\n \"provider_type\": \"External\",\n \"auth_type\": \"transmit\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"unspecified\",\n \"value\": \"\"\n }\n },\n {\n \"provider_name\": \"\",\n \"provider_type\": \"External\",\n \"auth_type\": \"email_magic_link\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"phone_number\",\n \"value\": \"\"\n }\n }\n ],\n \"last_auth\": \"\",\n \"external_account_id\": \"\",\n \"app_name\": \"\",\n \"custom_app_data\": {},\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"password_information\": {\n \"expired\": \"\",\n \"temporary\": \"\",\n \"updated_at\": \"\",\n \"expires_in\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-956f7fbe-cfbf-4b06-a1cf-7483a71b6f94" }, { "id": "5f6206b7-379c-41b9-bb9f-1444a536df7a", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/identifier?identifier_name=&identifier_value=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "identifier" ], "query": [ { "description": "(Required) Identifier name: one of the built-ins (email, phoneNumber, externalUserId, username, idpIdentifier) or a tenant-defined custom identifier", "key": "identifier_name", "value": "" }, { "description": "(Required) Identifier value", "key": "identifier_value", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": [\n \"\",\n \"\"\n ],\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-5f6206b7-379c-41b9-bb9f-1444a536df7a" }, { "id": "c6a516f6-9364-4bca-92b3-7c5b2fe6cf4d", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/identifier?identifier_name=&identifier_value=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "identifier" ], "query": [ { "description": "(Required) Identifier name: one of the built-ins (email, phoneNumber, externalUserId, username, idpIdentifier) or a tenant-defined custom identifier", "key": "identifier_name", "value": "" }, { "description": "(Required) Identifier value", "key": "identifier_value", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-c6a516f6-9364-4bca-92b3-7c5b2fe6cf4d" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-900224af-4067-4606-aed8-eb570d47ce02" } ], "id": "0a1e7424-0c6c-433d-9b37-6c579acacfcd", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-0a1e7424-0c6c-433d-9b37-6c579acacfcd" }, { "name": "{user_id}", "item": [ { "name": "groups", "item": [ { "name": "Get user's groups", "id": "3b7828aa-5b5e-4c28-a353-8930a43e41ca", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "groups" ], "variable": [ { "id": "3b07f08c-43db-477d-984f-d0fbbce27852", "key": "user_id", "value": "", "description": "(Required) ID of the user to retrieve groups for" } ] }, "description": "Retrieve a list of groups associated with a user.

**Required permissions**: `apps:read`, `[appId]:read`, `groups:read`." }, "response": [ { "id": "a2d2b77f-a0ec-404a-9bd1-4c56ba47167b", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "groups" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": [\n {\n \"group_id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"custom_data\": {}\n },\n {\n \"group_id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"custom_data\": {}\n }\n ]\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-a2d2b77f-a0ec-404a-9bd1-4c56ba47167b" }, { "id": "6c264440-ed6b-4896-9b50-d45fbe953612", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "groups" ], "variable": [ { "key": "user_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": [\n \"\",\n \"\"\n ],\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-6c264440-ed6b-4896-9b50-d45fbe953612" }, { "id": "93d60607-20f2-43c2-8bfc-2e88cb8a1743", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "groups" ], "variable": [ { "key": "user_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-93d60607-20f2-43c2-8bfc-2e88cb8a1743" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-3b7828aa-5b5e-4c28-a353-8930a43e41ca" } ], "id": "827e3549-476a-4a8b-8dec-00b54b600522", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-827e3549-476a-4a8b-8dec-00b54b600522" }, { "name": "apps", "item": [ { "name": "Remove user from app", "id": "e4a04651-9cee-4936-a3bf-c1a6cd940936", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/apps", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "apps" ], "variable": [ { "id": "c564e83d-1808-46bc-bcfb-b14f89a5f2fb", "key": "user_id", "value": "", "description": "(Required) The ID of the user to remove from application" } ] }, "description": "Remove a user from the requesting application.

**Required permissions**: `apps:edit`, `[appId]:edit`, `users:edit`." }, "response": [ { "id": "35890f42-b9f8-4139-92d8-4230c2616f48", "name": "User removed", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/apps", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "apps" ], "variable": [ { "key": "user_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-35890f42-b9f8-4139-92d8-4230c2616f48" }, { "id": "d39db812-cf06-4f47-a20e-c647459f4743", "name": "New Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/apps", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "apps" ], "variable": [ { "key": "user_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": [\n \"\",\n \"\"\n ],\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-d39db812-cf06-4f47-a20e-c647459f4743" }, { "id": "9d68696e-ba56-455d-b1b9-3fb02aa3eb8f", "name": "New Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/apps", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "apps" ], "variable": [ { "key": "user_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-9d68696e-ba56-455d-b1b9-3fb02aa3eb8f" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-e4a04651-9cee-4936-a3bf-c1a6cd940936" } ], "id": "60833701-2d27-4290-b749-757c305c9643", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-60833701-2d27-4290-b749-757c305c9643" }, { "name": "password", "item": [ { "name": "Create credentials", "id": "0b2a9372-d003-44bd-86cd-1a3d604854e9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"force_replace\": true,\n \"username\": \"\",\n \"enforce_complexity\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "password" ], "variable": [ { "id": "e242d28e-8aa7-48d9-9368-eb473a47db7a", "key": "user_id", "value": "", "description": "(Required) The ID of the user" } ] }, "description": "Creates new password credentials for a user that doesn't already have a password. The password is temporary, and must be reset upon the user's first login.

**Required permissions**: `apps:create`, `[appId]:create`, `authenticators:create`." }, "response": [ { "id": "33b3e2a4-cdac-41c7-8997-8617ea4cab44", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"force_replace\": true,\n \"username\": \"\",\n \"enforce_complexity\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "password" ], "variable": [ { "key": "user_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": {\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-33b3e2a4-cdac-41c7-8997-8617ea4cab44" }, { "id": "9d863096-67b9-4e71-bc52-d7f1e1eed2ff", "name": "Password validation errors", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"force_replace\": true,\n \"username\": \"\",\n \"enforce_complexity\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "password" ], "variable": [ { "key": "user_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"auth_password_breached\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-9d863096-67b9-4e71-bc52-d7f1e1eed2ff" }, { "id": "27881328-b79f-4e4b-a5e8-f8c59011b7fe", "name": "User does not exist", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"force_replace\": true,\n \"username\": \"\",\n \"enforce_complexity\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "password" ], "variable": [ { "key": "user_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"user_not_found\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-27881328-b79f-4e4b-a5e8-f8c59011b7fe" }, { "id": "3ff1c43c-6cde-4d83-9219-9da8fbb3d2c9", "name": "Password already configured for this user", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"force_replace\": true,\n \"username\": \"\",\n \"enforce_complexity\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "password" ], "variable": [ { "key": "user_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"auth_password_already_configured\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-3ff1c43c-6cde-4d83-9219-9da8fbb3d2c9" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-0b2a9372-d003-44bd-86cd-1a3d604854e9" }, { "name": "Update password", "id": "e57550d8-8a10-4a83-8473-e6da027c9931", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"force_replace\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "password" ], "variable": [ { "id": "0bf01bcf-02d3-4e06-9d27-b7c871f2977d", "key": "user_id", "value": "", "description": "(Required) The ID of the user" } ] }, "description": "Updates the user's existing credentials with a new temporary password, which must be reset the next time they login.

**Required permissions**: `apps:edit`, `[appId]:edit`, `authenticators:edit`." }, "response": [ { "id": "bf1dd2fd-e5e3-4589-9e78-050cf644573d", "name": "New Response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"force_replace\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "password" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": {\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-bf1dd2fd-e5e3-4589-9e78-050cf644573d" }, { "id": "b38ea81c-8782-4a0f-9d90-49b181b89ac7", "name": "Password validation errors", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"force_replace\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "password" ], "variable": [ { "key": "user_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"system_invalid_input\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-b38ea81c-8782-4a0f-9d90-49b181b89ac7" }, { "id": "a5576c39-0886-4362-9733-88adccbfc66d", "name": "User does not exist", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"force_replace\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "password" ], "variable": [ { "key": "user_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"user_not_found\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-a5576c39-0886-4362-9733-88adccbfc66d" }, { "id": "d368c370-2b8b-416f-936a-e0899f01b064", "name": "Password not configured for this user", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"force_replace\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "password" ], "variable": [ { "key": "user_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"auth_password_already_configured\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-d368c370-2b8b-416f-936a-e0899f01b064" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-e57550d8-8a10-4a83-8473-e6da027c9931" } ], "id": "b24dd7fa-e73d-4f66-937f-7fd7aeb8db0b", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-b24dd7fa-e73d-4f66-937f-7fd7aeb8db0b" }, { "name": "emails", "item": [ { "name": "{email}", "item": [ { "name": "verify", "item": [ { "name": "Mark email as verified", "id": "bf6d80b3-972c-485f-b3fb-ccf3ce435c43", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"change_to_primary\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/emails/:email/verify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "emails", ":email", "verify" ], "variable": [ { "id": "9998a371-6a48-40db-827d-4cfcd9c6e86b", "key": "user_id", "value": "", "description": "(Required) The ID of the user that should be updated" }, { "id": "8a15eb44-4ad9-41d9-961b-47600d710c7f", "key": "email", "value": "", "description": "(Required) The email of the user that should be verified" } ] }, "description": "Indicates that the user's email address was verified externally. A user's email address is automatically marked as verified when used in a Transmit authentication or verification flow. If the email address is a secondary email, the request can also be used to set it as the user's primary email (by setting `change_to_primary` to `true`).

**Required permissions**: `apps:edit`, `[appId]:edit`, `users:edit`." }, "response": [ { "id": "9d6721e2-0864-4879-803e-7a2446aee665", "name": "User email has been verified", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"change_to_primary\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/emails/:email/verify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "emails", ":email", "verify" ], "variable": [ { "key": "user_id" }, { "key": "email" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-9d6721e2-0864-4879-803e-7a2446aee665" }, { "id": "70c73ed1-84e7-4d37-9ffa-16dff6ff9f02", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"change_to_primary\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/emails/:email/verify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "emails", ":email", "verify" ], "variable": [ { "key": "user_id" }, { "key": "email" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-70c73ed1-84e7-4d37-9ffa-16dff6ff9f02" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-bf6d80b3-972c-485f-b3fb-ccf3ce435c43" } ], "id": "75e1961a-472b-4848-addb-96c4bc35bd0b", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-75e1961a-472b-4848-addb-96c4bc35bd0b" }, { "name": "Remove secondary email", "id": "23f8b07b-0a2a-4471-b590-ef264c2f7b47", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/emails/:email", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "emails", ":email" ], "variable": [ { "id": "ce638b27-8a37-4b6c-838f-c0f399c70319", "key": "user_id", "value": "", "description": "(Required) ID of the user" }, { "id": "bd102baa-c584-46f9-8b58-779e243777cb", "key": "email", "value": "", "description": "(Required) Secondary email to remove" } ] }, "description": "Removes a secondary email address from the user's profile.

**Required permissions**: `apps:edit`, `[appId]:edit`, `users:edit`." }, "response": [ { "id": "fe11dc62-eec8-4b0f-9e71-5a93273732f9", "name": "Secondary email is removed", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/emails/:email", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "emails", ":email" ], "variable": [ { "key": "user_id" }, { "key": "email" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-fe11dc62-eec8-4b0f-9e71-5a93273732f9" }, { "id": "67dc6ccc-a040-4d65-8615-3c20ced197e9", "name": "New Response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/emails/:email", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "emails", ":email" ], "variable": [ { "key": "user_id" }, { "key": "email" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-67dc6ccc-a040-4d65-8615-3c20ced197e9" }, { "id": "33c583d9-9414-4383-9613-2dc9c0f2e06d", "name": "New Response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/emails/:email", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "emails", ":email" ], "variable": [ { "key": "user_id" }, { "key": "email" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-33c583d9-9414-4383-9613-2dc9c0f2e06d" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-23f8b07b-0a2a-4471-b590-ef264c2f7b47" } ], "id": "0636a76c-a8d0-4d07-929f-2542c3c2b15e", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-0636a76c-a8d0-4d07-929f-2542c3c2b15e" } ], "id": "3476c4f9-9c02-4264-a342-9b73c92ae406", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-3476c4f9-9c02-4264-a342-9b73c92ae406" }, { "name": "phone-numbers", "item": [ { "name": "{phone_number}", "item": [ { "name": "verify", "item": [ { "name": "Mark phone as verified", "id": "f399989d-0997-42c3-84f6-05c41b7f5109", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"change_to_primary\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/phone-numbers/:phone_number/verify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "phone-numbers", ":phone_number", "verify" ], "variable": [ { "id": "ed0bdf0d-9210-4181-8a0d-a1f3f224132f", "key": "user_id", "value": "", "description": "(Required) The ID of the user that should be updated" }, { "id": "21083b68-f6b0-4061-82e1-1ba61d5ce15b", "key": "phone_number", "value": "", "description": "(Required) The phone number of the user that should be verified" } ] }, "description": "Indicates that the user's phone number was verified externally. A user's phone number is automatically marked as verified when used in a Transmit authentication or verification flow. If the phone number is a secondary one, the request can also be used to set it as the user's primary phone (by setting `change_to_primary` to `true`).

**Required permissions**: `apps:edit`, `[appId]:edit`, `users:edit`." }, "response": [ { "id": "68f87bff-6694-4984-a90c-516e0e9a9513", "name": "User phone number has been verified", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"change_to_primary\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/phone-numbers/:phone_number/verify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "phone-numbers", ":phone_number", "verify" ], "variable": [ { "key": "user_id" }, { "key": "phone_number" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-68f87bff-6694-4984-a90c-516e0e9a9513" }, { "id": "f7beb7e7-580f-49fd-9a38-9f5729c58a25", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"change_to_primary\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/phone-numbers/:phone_number/verify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "phone-numbers", ":phone_number", "verify" ], "variable": [ { "key": "user_id" }, { "key": "phone_number" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-f7beb7e7-580f-49fd-9a38-9f5729c58a25" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-f399989d-0997-42c3-84f6-05c41b7f5109" } ], "id": "0154806e-2fb8-4e6f-b919-09a68e797461", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-0154806e-2fb8-4e6f-b919-09a68e797461" }, { "name": "Remove secondary phone number", "id": "fbdab46c-5567-497e-83d4-6a2050625cdd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/phone-numbers/:phone_number", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "phone-numbers", ":phone_number" ], "variable": [ { "id": "1c0afae3-a3c0-4897-b801-933d1be152de", "key": "user_id", "value": "", "description": "(Required) ID of the user" }, { "id": "48da81a4-f6b8-4043-a6a9-580549af325b", "key": "phone_number", "value": "", "description": "(Required) Secondary phone number to remove" } ] }, "description": "Remove a secondary phone number from the user's profile.

**Required permissions**: `apps:edit`, `[appId]:edit`, `users:edit`." }, "response": [ { "id": "c8b07b1c-4647-48b4-b167-41f184f26f7b", "name": "Secondary phone number is removed", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/phone-numbers/:phone_number", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "phone-numbers", ":phone_number" ], "variable": [ { "key": "user_id" }, { "key": "phone_number" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-c8b07b1c-4647-48b4-b167-41f184f26f7b" }, { "id": "aca69a64-6a33-48df-ac2b-1a6d7fefd8cc", "name": "New Response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/phone-numbers/:phone_number", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "phone-numbers", ":phone_number" ], "variable": [ { "key": "user_id" }, { "key": "phone_number" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-aca69a64-6a33-48df-ac2b-1a6d7fefd8cc" }, { "id": "404755c6-882e-4d9e-be03-f9c7a6bf2600", "name": "New Response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/phone-numbers/:phone_number", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "phone-numbers", ":phone_number" ], "variable": [ { "key": "user_id" }, { "key": "phone_number" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-404755c6-882e-4d9e-be03-f9c7a6bf2600" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-fbdab46c-5567-497e-83d4-6a2050625cdd" } ], "id": "1167342c-f170-4ecf-b902-0c152b853a08", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-1167342c-f170-4ecf-b902-0c152b853a08" } ], "id": "ab79c85e-a576-4883-935a-c5cb69e449a5", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-ab79c85e-a576-4883-935a-c5cb69e449a5" }, { "name": "Get user by ID", "id": "8d40a1fb-a469-44f0-8d18-8ff9fd22b943", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id" ], "variable": [ { "id": "af3d39d2-8a8c-403e-819b-e442fff6efe1", "key": "user_id", "value": "", "description": "(Required) The user ID to search for" } ] }, "description": "Search for a user by user ID.

**Required permissions**: `apps:read`, `[appId]:read`, `users:read`." }, "response": [ { "id": "fc504313-9d46-4c3e-ac0f-9a3cd6a1a079", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": {\n \"user_id\": \"\",\n \"status\": \"Disabled\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_emails\": [\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"phone_number\": {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_phone_numbers\": [\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"username\": \"\",\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Home\",\n \"updated_at\": \"\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"status_changed_at\": \"\",\n \"identity_providers\": [\n {\n \"source\": \"UserID\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n },\n {\n \"source\": \"Transmit Security\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n }\n ],\n \"identities\": [\n {\n \"provider_name\": \"\",\n \"provider_type\": \"External\",\n \"auth_type\": \"password\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"unspecified\",\n \"value\": \"\"\n }\n },\n {\n \"provider_name\": \"\",\n \"provider_type\": \"OAuth2\",\n \"auth_type\": \"password\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"email\",\n \"value\": \"\"\n }\n }\n ],\n \"last_auth\": \"\",\n \"external_account_id\": \"\",\n \"app_name\": \"\",\n \"custom_app_data\": {},\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"password_information\": {\n \"expired\": \"\",\n \"temporary\": \"\",\n \"updated_at\": \"\",\n \"expires_in\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-fc504313-9d46-4c3e-ac0f-9a3cd6a1a079" }, { "id": "bb5e08a9-5d2c-436a-b354-fb300d8f2a84", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": [\n \"\",\n \"\"\n ],\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-bb5e08a9-5d2c-436a-b354-fb300d8f2a84" }, { "id": "bd6d6c8b-cd7d-4558-9c9f-4a7edf4adbc6", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-bd6d6c8b-cd7d-4558-9c9f-4a7edf4adbc6" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-8d40a1fb-a469-44f0-8d18-8ff9fd22b943" }, { "name": "Update user", "id": "1adfb08a-cd11-4abf-aeca-cc50624d1ba9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "user-agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"phone_number\": \"\",\n \"secondary_emails\": [\n \"\",\n \"\"\n ],\n \"secondary_phone_numbers\": [\n \"\",\n \"\"\n ],\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Home\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"status\": \"Disabled\",\n \"external_account_id\": \"\",\n \"custom_app_data\": {},\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"username\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id" ], "variable": [ { "id": "73cc0c57-dbed-4e88-a39f-8a4654d3dedd", "key": "user_id", "value": "", "description": "(Required) The ID of the user that should be updated" } ] }, "description": "Update a user's attributes or their custom data. Changes will be merged into the user's profile, so you can specify only the fields you want to update.

**Note:**
  • Attributes (like name and address) **cannot** be partially updated, as the new value of an object or array will just replace the current one.
  • `custom_data` **can** be partially updated since it will be merged with the existing data (as a shallow merge).
.

**Required permissions**: `apps:edit`, `[appId]:edit`, `users:edit`." }, "response": [ { "id": "31a918f6-6bcb-469e-9fcf-bddb00009973", "name": "New Response", "originalRequest": { "method": "PUT", "header": [ { "key": "user-agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"phone_number\": \"\",\n \"secondary_emails\": [\n \"\",\n \"\"\n ],\n \"secondary_phone_numbers\": [\n \"\",\n \"\"\n ],\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Home\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"status\": \"Disabled\",\n \"external_account_id\": \"\",\n \"custom_app_data\": {},\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"username\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": {\n \"user_id\": \"\",\n \"status\": \"Disabled\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_emails\": [\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"phone_number\": {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_phone_numbers\": [\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"username\": \"\",\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Work\",\n \"updated_at\": \"\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"status_changed_at\": \"\",\n \"identity_providers\": [\n {\n \"source\": \"totp\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n },\n {\n \"source\": \"Orchestrated\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n }\n ],\n \"identities\": [\n {\n \"provider_name\": \"\",\n \"provider_type\": \"Native\",\n \"auth_type\": \"direct_otp\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"username\",\n \"value\": \"\"\n }\n },\n {\n \"provider_name\": \"\",\n \"provider_type\": \"External\",\n \"auth_type\": \"password\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"unspecified\",\n \"value\": \"\"\n }\n }\n ],\n \"last_auth\": \"\",\n \"external_account_id\": \"\",\n \"app_name\": \"\",\n \"custom_app_data\": {},\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"password_information\": {\n \"expired\": \"\",\n \"temporary\": \"\",\n \"updated_at\": \"\",\n \"expires_in\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-31a918f6-6bcb-469e-9fcf-bddb00009973" }, { "id": "efc85aa5-bee7-4ec8-a4a4-a0ca63ffab2b", "name": "New Response", "originalRequest": { "method": "PUT", "header": [ { "key": "user-agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"phone_number\": \"\",\n \"secondary_emails\": [\n \"\",\n \"\"\n ],\n \"secondary_phone_numbers\": [\n \"\",\n \"\"\n ],\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Home\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"status\": \"Disabled\",\n \"external_account_id\": \"\",\n \"custom_app_data\": {},\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"username\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": [\n \"\",\n \"\"\n ],\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-efc85aa5-bee7-4ec8-a4a4-a0ca63ffab2b" }, { "id": "9d7e75d0-853b-4dd3-91b2-66e945a4ef20", "name": "New Response", "originalRequest": { "method": "PUT", "header": [ { "key": "user-agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"phone_number\": \"\",\n \"secondary_emails\": [\n \"\",\n \"\"\n ],\n \"secondary_phone_numbers\": [\n \"\",\n \"\"\n ],\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Home\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"status\": \"Disabled\",\n \"external_account_id\": \"\",\n \"custom_app_data\": {},\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"username\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-9d7e75d0-853b-4dd3-91b2-66e945a4ef20" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-1adfb08a-cd11-4abf-aeca-cc50624d1ba9" } ], "id": "11080f00-cdb7-4047-bf0c-a0c2cd103044", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-11080f00-cdb7-4047-bf0c-a0c2cd103044" }, { "name": "email", "item": [ { "name": "{email}", "item": [ { "name": "Get user by email", "id": "8c2d0a1f-b9c1-4cfc-929e-0e4f1d4d1932", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/email/:email", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "email", ":email" ], "variable": [ { "id": "ca8ee2d7-1b85-4dab-b4a9-86f1cab9c8a9", "key": "email", "value": "", "description": "(Required) The user's primary email to search for" } ] }, "description": "Search for a user by primary email.

**Required permissions**: `apps:read`, `[appId]:read`, `users:read`." }, "response": [ { "id": "d4ccc56e-6d6e-4de4-a3ff-9029cf138c44", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/email/:email", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "email", ":email" ], "variable": [ { "key": "email" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": {\n \"user_id\": \"\",\n \"status\": \"Pending\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_emails\": [\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"phone_number\": {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_phone_numbers\": [\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"username\": \"\",\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Work\",\n \"updated_at\": \"\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"status_changed_at\": \"\",\n \"identity_providers\": [\n {\n \"source\": \"BindIDApi\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n },\n {\n \"source\": \"Transmit Security\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n }\n ],\n \"identities\": [\n {\n \"provider_name\": \"\",\n \"provider_type\": \"OAuth2\",\n \"auth_type\": \"webauthn\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"unspecified\",\n \"value\": \"\"\n }\n },\n {\n \"provider_name\": \"\",\n \"provider_type\": \"External\",\n \"auth_type\": \"sms_otp\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"username\",\n \"value\": \"\"\n }\n }\n ],\n \"last_auth\": \"\",\n \"external_account_id\": \"\",\n \"app_name\": \"\",\n \"custom_app_data\": {},\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"password_information\": {\n \"expired\": \"\",\n \"temporary\": \"\",\n \"updated_at\": \"\",\n \"expires_in\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-d4ccc56e-6d6e-4de4-a3ff-9029cf138c44" }, { "id": "cea53bd0-50d8-46aa-acf6-7f28d5c0e98a", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/email/:email", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "email", ":email" ], "variable": [ { "key": "email" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": [\n \"\",\n \"\"\n ],\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-cea53bd0-50d8-46aa-acf6-7f28d5c0e98a" }, { "id": "9444f690-9451-43da-b51a-8d3b86d50ce7", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/email/:email", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "email", ":email" ], "variable": [ { "key": "email" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-9444f690-9451-43da-b51a-8d3b86d50ce7" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-8c2d0a1f-b9c1-4cfc-929e-0e4f1d4d1932" } ], "id": "939890d6-58ea-4288-ad5f-bb143eddd192", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-939890d6-58ea-4288-ad5f-bb143eddd192" } ], "id": "fabb24cc-fddc-4d27-90b0-4795d042179a", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-fabb24cc-fddc-4d27-90b0-4795d042179a" }, { "name": "external-user-id", "item": [ { "name": "{external_user_id}", "item": [ { "name": "Get user by external user ID", "id": "c903c523-7b41-4722-a7cb-347fb96e67f2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/external-user-id/:external_user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "external-user-id", ":external_user_id" ], "variable": [ { "id": "23c1f678-543e-45eb-a5a1-c97d531b25aa", "key": "external_user_id", "value": "", "description": "(Required) The external user ID to search for" } ] }, "description": "Search for a user by their external_user_id, which represents the user identifier in external provider.

**Required permissions**: `apps:read`, `[appId]:read`, `users:read`." }, "response": [ { "id": "515f2b0f-074c-4c0f-9560-7782bd6edbb1", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/external-user-id/:external_user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "external-user-id", ":external_user_id" ], "variable": [ { "key": "external_user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": {\n \"user_id\": \"\",\n \"status\": \"Disabled\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_emails\": [\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"phone_number\": {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_phone_numbers\": [\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"username\": \"\",\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Other\",\n \"updated_at\": \"\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"status_changed_at\": \"\",\n \"identity_providers\": [\n {\n \"source\": \"BindIDApi\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n },\n {\n \"source\": \"Orchestrated\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n }\n ],\n \"identities\": [\n {\n \"provider_name\": \"\",\n \"provider_type\": \"External\",\n \"auth_type\": \"totp\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"username\",\n \"value\": \"\"\n }\n },\n {\n \"provider_name\": \"\",\n \"provider_type\": \"OAuth2\",\n \"auth_type\": \"oauth2\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"email\",\n \"value\": \"\"\n }\n }\n ],\n \"last_auth\": \"\",\n \"external_account_id\": \"\",\n \"app_name\": \"\",\n \"custom_app_data\": {},\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"password_information\": {\n \"expired\": \"\",\n \"temporary\": \"\",\n \"updated_at\": \"\",\n \"expires_in\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-515f2b0f-074c-4c0f-9560-7782bd6edbb1" }, { "id": "b39031c5-acb9-4bcb-8133-1fcbe2a4e869", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/external-user-id/:external_user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "external-user-id", ":external_user_id" ], "variable": [ { "key": "external_user_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": [\n \"\",\n \"\"\n ],\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-b39031c5-acb9-4bcb-8133-1fcbe2a4e869" }, { "id": "96c35814-a8d9-4a5e-940b-75eb71cd9009", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/external-user-id/:external_user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "external-user-id", ":external_user_id" ], "variable": [ { "key": "external_user_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-96c35814-a8d9-4a5e-940b-75eb71cd9009" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-c903c523-7b41-4722-a7cb-347fb96e67f2" } ], "id": "469a853d-bca4-49f5-9297-061d1094ba77", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-469a853d-bca4-49f5-9297-061d1094ba77" } ], "id": "787de133-bbdd-4ac9-ac10-8ba7025cda10", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-787de133-bbdd-4ac9-ac10-8ba7025cda10" }, { "name": "username", "item": [ { "name": "{username}", "item": [ { "name": "Get user by username", "id": "bee8410e-49c7-4615-8880-1134ba617acb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/username/:username", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "username", ":username" ], "variable": [ { "id": "4aaf5c7c-5326-4603-9b5d-381a6807ca06", "key": "username", "value": "", "description": "(Required) The user's username to search for" } ] }, "description": "Search for a user by username.

**Required permissions**: `apps:read`, `[appId]:read`, `users:read`." }, "response": [ { "id": "9439e274-73c8-4265-bf72-7407110ee20e", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/username/:username", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "username", ":username" ], "variable": [ { "key": "username" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": {\n \"user_id\": \"\",\n \"status\": \"Disabled\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_emails\": [\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"phone_number\": {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_phone_numbers\": [\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"username\": \"\",\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Home\",\n \"updated_at\": \"\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"status_changed_at\": \"\",\n \"identity_providers\": [\n {\n \"source\": \"Orchestrated\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n },\n {\n \"source\": \"Tiktok\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n }\n ],\n \"identities\": [\n {\n \"provider_name\": \"\",\n \"provider_type\": \"Native\",\n \"auth_type\": \"direct_otp\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"username\",\n \"value\": \"\"\n }\n },\n {\n \"provider_name\": \"\",\n \"provider_type\": \"OAuth2\",\n \"auth_type\": \"email_otp\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"unspecified\",\n \"value\": \"\"\n }\n }\n ],\n \"last_auth\": \"\",\n \"external_account_id\": \"\",\n \"app_name\": \"\",\n \"custom_app_data\": {},\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"password_information\": {\n \"expired\": \"\",\n \"temporary\": \"\",\n \"updated_at\": \"\",\n \"expires_in\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-9439e274-73c8-4265-bf72-7407110ee20e" }, { "id": "d3f7fafb-f7c6-4e6d-babd-4801789ca1a7", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/username/:username", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "username", ":username" ], "variable": [ { "key": "username" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": [\n \"\",\n \"\"\n ],\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-d3f7fafb-f7c6-4e6d-babd-4801789ca1a7" }, { "id": "51d5efbf-302e-42f4-974a-77d5ded0dc9b", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/username/:username", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "username", ":username" ], "variable": [ { "key": "username" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-51d5efbf-302e-42f4-974a-77d5ded0dc9b" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-bee8410e-49c7-4615-8880-1134ba617acb" } ], "id": "99aa49f7-ca18-4dc4-8bb7-56b909d274ab", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-99aa49f7-ca18-4dc4-8bb7-56b909d274ab" } ], "id": "1d805bcc-c8bc-4234-a498-f1f8ded419cd", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-1d805bcc-c8bc-4234-a498-f1f8ded419cd" }, { "name": "phone", "item": [ { "name": "{phone_number}", "item": [ { "name": "Get user by phone number", "id": "48bcb51a-ad57-4f66-a44a-04502454f09d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/phone/:phone_number", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "phone", ":phone_number" ], "variable": [ { "id": "e4aaa765-cd7e-4e42-b1de-b25b9106ab58", "key": "phone_number", "value": "", "description": "(Required) The phone number of the user to get" } ] }, "description": "Search for a user by their primary phone number" }, "response": [ { "id": "8657c470-73b4-4597-b99f-e417422325ee", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/phone/:phone_number", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "phone", ":phone_number" ], "variable": [ { "key": "phone_number" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": {\n \"user_id\": \"\",\n \"status\": \"Disabled\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_emails\": [\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"phone_number\": {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_phone_numbers\": [\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"username\": \"\",\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Other\",\n \"updated_at\": \"\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"status_changed_at\": \"\",\n \"identity_providers\": [\n {\n \"source\": \"Email OTP\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n },\n {\n \"source\": \"totp\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n }\n ],\n \"identities\": [\n {\n \"provider_name\": \"\",\n \"provider_type\": \"Native\",\n \"auth_type\": \"totp\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"username\",\n \"value\": \"\"\n }\n },\n {\n \"provider_name\": \"\",\n \"provider_type\": \"Native\",\n \"auth_type\": \"saml\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"username\",\n \"value\": \"\"\n }\n }\n ],\n \"last_auth\": \"\",\n \"external_account_id\": \"\",\n \"app_name\": \"\",\n \"custom_app_data\": {},\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"password_information\": {\n \"expired\": \"\",\n \"temporary\": \"\",\n \"updated_at\": \"\",\n \"expires_in\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-8657c470-73b4-4597-b99f-e417422325ee" }, { "id": "c190e0e0-a0ff-4bbe-a254-fa0119759c7e", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/phone/:phone_number", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "phone", ":phone_number" ], "variable": [ { "key": "phone_number" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": [\n \"\",\n \"\"\n ],\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-c190e0e0-a0ff-4bbe-a254-fa0119759c7e" }, { "id": "42f215a3-dc6e-489a-a2f3-2c689be977e5", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/phone/:phone_number", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "phone", ":phone_number" ], "variable": [ { "key": "phone_number" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-42f215a3-dc6e-489a-a2f3-2c689be977e5" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-48bcb51a-ad57-4f66-a44a-04502454f09d" } ], "id": "b8db2ac4-d35c-4909-8684-aa468b44c47d", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-b8db2ac4-d35c-4909-8684-aa468b44c47d" } ], "id": "d28481fb-8753-46ba-bf7d-6e148faadca8", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-d28481fb-8753-46ba-bf7d-6e148faadca8" }, { "name": "phone-number", "item": [ { "name": "{phone_number}", "item": [ { "name": "Get user by phone number", "id": "bedbc676-1e56-459a-b1d6-f00aa8e2736e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/phone-number/:phone_number", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "phone-number", ":phone_number" ], "variable": [ { "id": "91cc2f9d-c516-441b-bc5a-cdfa38a7e69b", "key": "phone_number", "value": "", "description": "(Required) The phone number of the user to get" } ] }, "description": "Search for a user by their primary phone number.

**Required permissions**: `apps:read`, `[appId]:read`, `users:read`." }, "response": [ { "id": "6209b2b0-1e1c-4ccc-a2d0-62cae3ee6f52", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/phone-number/:phone_number", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "phone-number", ":phone_number" ], "variable": [ { "key": "phone_number" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": {\n \"user_id\": \"\",\n \"status\": \"Disabled\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_emails\": [\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"phone_number\": {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_phone_numbers\": [\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"username\": \"\",\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Home\",\n \"updated_at\": \"\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"status_changed_at\": \"\",\n \"identity_providers\": [\n {\n \"source\": \"Password\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n },\n {\n \"source\": \"Orchestrated\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n }\n ],\n \"identities\": [\n {\n \"provider_name\": \"\",\n \"provider_type\": \"Native\",\n \"auth_type\": \"direct_otp\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"unspecified\",\n \"value\": \"\"\n }\n },\n {\n \"provider_name\": \"\",\n \"provider_type\": \"External\",\n \"auth_type\": \"transmit\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"email\",\n \"value\": \"\"\n }\n }\n ],\n \"last_auth\": \"\",\n \"external_account_id\": \"\",\n \"app_name\": \"\",\n \"custom_app_data\": {},\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"password_information\": {\n \"expired\": \"\",\n \"temporary\": \"\",\n \"updated_at\": \"\",\n \"expires_in\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-6209b2b0-1e1c-4ccc-a2d0-62cae3ee6f52" }, { "id": "56ad800f-611a-42fd-ae83-12825cbfd3d8", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/phone-number/:phone_number", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "phone-number", ":phone_number" ], "variable": [ { "key": "phone_number" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": [\n \"\",\n \"\"\n ],\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-56ad800f-611a-42fd-ae83-12825cbfd3d8" }, { "id": "cd458251-aa68-42a0-88e1-6b05fdc432d6", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users/phone-number/:phone_number", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "phone-number", ":phone_number" ], "variable": [ { "key": "phone_number" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-cd458251-aa68-42a0-88e1-6b05fdc432d6" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-bedbc676-1e56-459a-b1d6-f00aa8e2736e" } ], "id": "077bdada-5f55-4e08-9586-d9c09589f0ac", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-077bdada-5f55-4e08-9586-d9c09589f0ac" } ], "id": "91ffed42-fb71-4567-b73b-11426039e79f", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-91ffed42-fb71-4567-b73b-11426039e79f" }, { "name": "me", "item": [ { "name": "password-credentials", "item": [ { "name": "Register password", "id": "68e1aae3-172c-4e1f-a109-53c539abbe6f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"username\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/me/password-credentials", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me", "password-credentials" ] }, "description": "Allows a logged-in user to register their first password. Must be authorized using a valid user access token returned upon successful authentication." }, "response": [ { "id": "44d210a2-095c-4603-bdd0-7cdad67d4999", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"username\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/me/password-credentials", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me", "password-credentials" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": {\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-44d210a2-095c-4603-bdd0-7cdad67d4999" }, { "id": "47a50db1-5ae4-4b08-9b05-c53bb8314e46", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"username\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/me/password-credentials", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me", "password-credentials" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-47a50db1-5ae4-4b08-9b05-c53bb8314e46" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-68e1aae3-172c-4e1f-a109-53c539abbe6f" } ], "id": "79ae7815-fc91-4b3f-87b3-95aeefbafdeb", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-79ae7815-fc91-4b3f-87b3-95aeefbafdeb" }, { "name": "device-keys", "item": [ { "name": "Get current user's device keys", "id": "59eb54aa-cf7a-44ad-acc9-5c99d7d57126", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/me/device-keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me", "device-keys" ] }, "description": "Get device keys by user id" }, "response": [ { "id": "c8501616-a818-49d8-948f-ffe41b6dd4d8", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/users/me/device-keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me", "device-keys" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": {\n \"status\": \"Blocked\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"display_name\": \"\",\n \"custom_data\": {},\n \"push_config\": {\n \"device_token\": \"\",\n \"type\": \"FCM\",\n \"bundle_id\": \"\"\n },\n \"key_id\": \"\"\n }\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-c8501616-a818-49d8-948f-ffe41b6dd4d8" }, { "id": "eb81b0c8-d11d-4027-b010-ab93096fe289", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/users/me/device-keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me", "device-keys" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-eb81b0c8-d11d-4027-b010-ab93096fe289" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-59eb54aa-cf7a-44ad-acc9-5c99d7d57126" } ], "id": "be23b5a8-c5fe-4da1-a43a-f809f64c5f21", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-be23b5a8-c5fe-4da1-a43a-f809f64c5f21" } ], "id": "fbab749f-a069-46d2-a515-c709fc515fcc", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-fbab749f-a069-46d2-a515-c709fc515fcc" }, { "name": "Create user", "id": "c0a4af0f-d1c2-461e-803e-7fd04564815b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"phone_number\": \"\",\n \"username\": \"\",\n \"secondary_emails\": [\n \"\",\n \"\"\n ],\n \"secondary_phone_numbers\": [\n \"\",\n \"\"\n ],\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Work\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"external_account_id\": \"\",\n \"custom_app_data\": {},\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"credentials\": {\n \"password\": \"\",\n \"force_replace\": true\n },\n \"delegated_access\": {\n \"actor_id\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users" ] }, "description": "Add a user to Transmit. A user_id is returned as part of the User in the response that can then be used to perform other operations, such as get, update and delete. An email or a phone_number are required.

**Required permissions**: `apps:create`, `[appId]:create`, `users:create`." }, "response": [ { "id": "9f96eb59-d774-4daf-8c41-5a578ce2e0b6", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"phone_number\": \"\",\n \"username\": \"\",\n \"secondary_emails\": [\n \"\",\n \"\"\n ],\n \"secondary_phone_numbers\": [\n \"\",\n \"\"\n ],\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Work\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"external_account_id\": \"\",\n \"custom_app_data\": {},\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"credentials\": {\n \"password\": \"\",\n \"force_replace\": true\n },\n \"delegated_access\": {\n \"actor_id\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": {\n \"user_id\": \"\",\n \"status\": \"Active\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_emails\": [\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"phone_number\": {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_phone_numbers\": [\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"username\": \"\",\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Home\",\n \"updated_at\": \"\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"status_changed_at\": \"\",\n \"identity_providers\": [\n {\n \"source\": \"Orchestrated\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n },\n {\n \"source\": \"SAML\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n }\n ],\n \"identities\": [\n {\n \"provider_name\": \"\",\n \"provider_type\": \"External\",\n \"auth_type\": \"oauth2\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"username\",\n \"value\": \"\"\n }\n },\n {\n \"provider_name\": \"\",\n \"provider_type\": \"Native\",\n \"auth_type\": \"password\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"username\",\n \"value\": \"\"\n }\n }\n ],\n \"last_auth\": \"\",\n \"external_account_id\": \"\",\n \"app_name\": \"\",\n \"custom_app_data\": {},\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"password_information\": {\n \"expired\": \"\",\n \"temporary\": \"\",\n \"updated_at\": \"\",\n \"expires_in\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-9f96eb59-d774-4daf-8c41-5a578ce2e0b6" }, { "id": "16ed6b2c-cf0d-48d3-9e2c-e08717a0e18c", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"phone_number\": \"\",\n \"username\": \"\",\n \"secondary_emails\": [\n \"\",\n \"\"\n ],\n \"secondary_phone_numbers\": [\n \"\",\n \"\"\n ],\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Work\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"external_account_id\": \"\",\n \"custom_app_data\": {},\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"credentials\": {\n \"password\": \"\",\n \"force_replace\": true\n },\n \"delegated_access\": {\n \"actor_id\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": [\n \"\",\n \"\"\n ],\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-16ed6b2c-cf0d-48d3-9e2c-e08717a0e18c" }, { "id": "e645e2ee-5566-4684-91e4-6e5265a1021c", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"phone_number\": \"\",\n \"username\": \"\",\n \"secondary_emails\": [\n \"\",\n \"\"\n ],\n \"secondary_phone_numbers\": [\n \"\",\n \"\"\n ],\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Work\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"external_account_id\": \"\",\n \"custom_app_data\": {},\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"credentials\": {\n \"password\": \"\",\n \"force_replace\": true\n },\n \"delegated_access\": {\n \"actor_id\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"ts_error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-e645e2ee-5566-4684-91e4-6e5265a1021c" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-c0a4af0f-d1c2-461e-803e-7fd04564815b" }, { "name": "Get users", "id": "00cbe118-026d-4879-8a8e-68d71268c93b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "/oidc/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users?search=&page_offset=&page_limit=&search_prefix=&sort_field=created_at&sort_order=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users" ], "query": [ { "description": "Search expression based on the [SCIM protocol](https://www.rfc-editor.org/rfc/rfc7644#section-3.4.2.2). For syntax and searchable fields, see [Search query syntax](/openapi/scim_search_syntax/)", "key": "search", "value": "" }, { "description": "Number of users you wish to skip before selecting users", "key": "page_offset", "value": "" }, { "description": "Number of users to return in page", "key": "page_limit", "value": "" }, { "description": "Value to search for in the primary email and phone_number fields, where the search value must match the prefix of the field value. For example, \"search_prefix=john\" will return users whose email starts with \"john\" and \"search_prefix=%2B1212\" returns users whose phone number starts with \"+1212\".", "key": "search_prefix", "value": "" }, { "description": "The name of the field you wish to sort by. Mgmt flows also support: organization_added_at (sort by when member was added to org)", "key": "sort_field", "value": "created_at" }, { "description": "The order of the sort", "key": "sort_order", "value": "asc" } ] }, "description": "Search across your application\u2019s users at Transmit. This endpoint also allows you to return all of your application\u2019s users by sending no filters at all.

**Required permissions**: `users:read`, `users:list`, `apps:read`, `[appId]:read`, `apps:list`, `[appId]:list`." }, "response": [ { "id": "7402dc13-604d-43ee-abcc-934286658cbd", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users?search=&page_offset=&page_limit=&search_prefix=&sort_field=created_at&sort_order=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users" ], "query": [ { "description": "Search expression based on the [SCIM protocol](https://www.rfc-editor.org/rfc/rfc7644#section-3.4.2.2). For syntax and searchable fields, see [Search query syntax](/openapi/scim_search_syntax/)", "key": "search", "value": "" }, { "description": "Number of users you wish to skip before selecting users", "key": "page_offset", "value": "" }, { "description": "Number of users to return in page", "key": "page_limit", "value": "" }, { "description": "Value to search for in the primary email and phone_number fields, where the search value must match the prefix of the field value. For example, \"search_prefix=john\" will return users whose email starts with \"john\" and \"search_prefix=%2B1212\" returns users whose phone number starts with \"+1212\".", "key": "search_prefix", "value": "" }, { "description": "The name of the field you wish to sort by. Mgmt flows also support: organization_added_at (sort by when member was added to org)", "key": "sort_field", "value": "created_at" }, { "description": "The order of the sort", "key": "sort_order", "value": "asc" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total_count\": \"\",\n \"page_info\": {\n \"has_next_page\": \"\",\n \"has_previous_page\": \"\"\n },\n \"result\": [\n {\n \"user_id\": \"\",\n \"status\": \"Disabled\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_emails\": [\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"phone_number\": {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_phone_numbers\": [\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"username\": \"\",\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Home\",\n \"updated_at\": \"\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"status_changed_at\": \"\",\n \"identity_providers\": [\n {\n \"source\": \"Facebook\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n },\n {\n \"source\": \"Line\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n }\n ],\n \"identities\": [\n {\n \"provider_name\": \"\",\n \"provider_type\": \"Native\",\n \"auth_type\": \"direct_otp\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"phone_number\",\n \"value\": \"\"\n }\n },\n {\n \"provider_name\": \"\",\n \"provider_type\": \"OAuth2\",\n \"auth_type\": \"totp\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"email\",\n \"value\": \"\"\n }\n }\n ],\n \"last_auth\": \"\",\n \"external_account_id\": \"\",\n \"app_name\": \"\",\n \"custom_app_data\": {},\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"password_information\": {\n \"expired\": \"\",\n \"temporary\": \"\",\n \"updated_at\": \"\",\n \"expires_in\": \"\"\n }\n },\n {\n \"user_id\": \"\",\n \"status\": \"Disabled\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_emails\": [\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"email_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"phone_number\": {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n \"secondary_phone_numbers\": [\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"value\": \"\",\n \"phone_number_verified\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"username\": \"\",\n \"birthday\": \"\",\n \"address\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street_address\": \"\",\n \"postal_code\": \"\",\n \"type\": \"Other\",\n \"updated_at\": \"\"\n },\n \"name\": {\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\"\n },\n \"status_changed_at\": \"\",\n \"identity_providers\": [\n {\n \"source\": \"Transmit Security\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n },\n {\n \"source\": \"UserID\",\n \"identifier\": \"\",\n \"email\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\"\n }\n ],\n \"identities\": [\n {\n \"provider_name\": \"\",\n \"provider_type\": \"OAuth2\",\n \"auth_type\": \"totp\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"unspecified\",\n \"value\": \"\"\n }\n },\n {\n \"provider_name\": \"\",\n \"provider_type\": \"External\",\n \"auth_type\": \"totp\",\n \"identifier\": \"\",\n \"first_auth_date\": \"\",\n \"last_auth_date\": \"\",\n \"user_alias\": {\n \"type\": \"unspecified\",\n \"value\": \"\"\n }\n }\n ],\n \"last_auth\": \"\",\n \"external_account_id\": \"\",\n \"app_name\": \"\",\n \"custom_app_data\": {},\n \"groupIds\": [\n \"\",\n \"\"\n ],\n \"picture\": \"\",\n \"language\": \"\",\n \"custom_data\": {},\n \"external_user_id\": \"\",\n \"password_information\": {\n \"expired\": \"\",\n \"temporary\": \"\",\n \"updated_at\": \"\",\n \"expires_in\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-7402dc13-604d-43ee-abcc-934286658cbd" }, { "id": "75f1a09d-a985-4dd3-b00d-b760cfb81b8d", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/users?search=&page_offset=&page_limit=&search_prefix=&sort_field=created_at&sort_order=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users" ], "query": [ { "description": "Search expression based on the [SCIM protocol](https://www.rfc-editor.org/rfc/rfc7644#section-3.4.2.2). For syntax and searchable fields, see [Search query syntax](/openapi/scim_search_syntax/)", "key": "search", "value": "" }, { "description": "Number of users you wish to skip before selecting users", "key": "page_offset", "value": "" }, { "description": "Number of users to return in page", "key": "page_limit", "value": "" }, { "description": "Value to search for in the primary email and phone_number fields, where the search value must match the prefix of the field value. For example, \"search_prefix=john\" will return users whose email starts with \"john\" and \"search_prefix=%2B1212\" returns users whose phone number starts with \"+1212\".", "key": "search_prefix", "value": "" }, { "description": "The name of the field you wish to sort by. Mgmt flows also support: organization_added_at (sort by when member was added to org)", "key": "sort_field", "value": "created_at" }, { "description": "The order of the sort", "key": "sort_order", "value": "asc" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": [\n \"\",\n \"\"\n ],\n \"error_code\": \"\"\n}", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-75f1a09d-a985-4dd3-b00d-b760cfb81b8d" } ], "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-00cbe118-026d-4879-8a8e-68d71268c93b" } ], "id": "4978edde-a91c-47ae-a947-1c9b052a8f56", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-4978edde-a91c-47ae-a947-1c9b052a8f56" } ], "id": "a3fab8e1-a8d6-457a-afc3-1a147ae2e563", "createdAt": "2026-07-28T11:05:17.000Z", "updatedAt": "2026-07-28T11:05:17.000Z", "uid": "35240-a3fab8e1-a8d6-457a-afc3-1a147ae2e563" } ], "variable": [ { "key": "baseUrl", "value": "https://api.sbx.transmitsecurity.io/cis" } ] }