{"items":[{"type":"link","label":"Admin users","link":"/openapi/user/admin-users.openapi","routeSlug":"/openapi/user/admin-users.openapi","content":{"contentType":"overview","meta":{"name":"Admin users"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"admin-users.openapi.json","url":"/_bundle/openapi/user/admin-users.openapi.json?download"},{"kind":"download","label":"admin-users.openapi.yaml","url":"/_bundle/openapi/user/admin-users.openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"cURL","lang":"curl"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"go","title":"Go","lang":"Go"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"java","title":"Java","lang":"Java"},{"key":"python","title":"Python","lang":"Python"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Admin users","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Manage admin user profiles"}],"sectionId":"/openapi/user/admin-users.openapi"}],"sectionId":"/openapi/user/admin-users.openapi"}]}]}},{"label":"Create new admin user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/admin-users.openapi/other/createorassignadminuser","routeSlug":"/openapi/user/admin-users.openapi/other/createorassignadminuser","metadata":{"seo":{"title":"Create new admin user","description":"Adds a new admin user to Mosaic."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrAssignAdminUser","name":"Create new admin user","isWebhook":false,"pointer":"/paths/~1v1~1admin-users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create new admin user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a new admin user to Mosaic."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAdminInput"}},"schemaId":"components/schemas/CreateAdminInput","pointer":"/paths/~1v1~1admin-users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/admin-users","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateAdminInput"}},"responseCodes":["200"],"pointer":"/v1/admin-users","href":"other/createorassignadminuser","openApiOperationId":"createOrAssignAdminUser","summary":"Create new admin user","securityGroups":[{"bearer":[]},{"ClientAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"schemaId":"components/schemas/CreateAdminInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAdminInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_305"}},"schemaId":"schema_305"}],"pointer":"/paths/~1v1~1admin-users/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_305","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_305"}}}],"examples":[]}]}]}]},"httpPath":"/v1/admin-users"},{"label":"Get a list of all admin users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/admin-users.openapi/other/getadminusers","routeSlug":"/openapi/user/admin-users.openapi/other/getadminusers","metadata":{"seo":{"title":"Get a list of all admin users","description":"Retrieves a list of admin users in Mosaic."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAdminUsers","name":"Get a list of all admin users","isWebhook":false,"pointer":"/paths/~1v1~1admin-users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of all admin users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of admin users in Mosaic."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/admin-users","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/admin-users","href":"other/getadminusers","openApiOperationId":"getAdminUsers","summary":"Get a list of all admin users","securityGroups":[{"bearer":[]},{"ClientAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_306"}},"schemaId":"schema_306"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"}],"pointer":"/paths/~1v1~1admin-users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_306","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_306"}}},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/admin-users"},{"label":"Delete admin user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/admin-users.openapi/other/removeadminuser","routeSlug":"/openapi/user/admin-users.openapi/other/removeadminuser","metadata":{"seo":{"title":"Delete admin user","description":"Deletes an admin user from Mosaic."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeAdminUser","name":"Delete admin user","isWebhook":false,"pointer":"/paths/~1v1~1admin-users~1{admin_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete admin user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an admin user from Mosaic."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"admin_id","in":"path","schemaId":"schema_307","required":true}],"pointer":"/paths/~1v1~1admin-users~1{admin_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/admin-users/{admin_id}","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"admin_id","in":"path","required":true,"schemaId":"schema_307"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/admin-users/{admin_id}","href":"other/removeadminuser","openApiOperationId":"removeAdminUser","summary":"Delete admin user","securityGroups":[{"bearer":[]},{"ClientAccessToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Admin deleted successfully"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"}],"pointer":"/paths/~1v1~1admin-users~1{admin_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/admin-users/{admin_id}"}],"store":{"schemaStore":{"components/schemas/NotFoundHttpError":{"id":"components/schemas/NotFoundHttpError","kind":"json-schema","title":"NotFoundHttpError","data":{"type":"object","properties":{"message":{"type":"string"},"error_code":{"type":"number","example":404}},"required":["message","error_code"]}},"components/schemas/ApiAdminUser":{"id":"components/schemas/ApiAdminUser","kind":"json-schema","title":"ApiAdminUser","data":{"type":"object","properties":{"email":{"description":"Primary email address, used as user identifier","allOf":[{"$ref":"#/components/schemas/ApiUserEmail"}]},"user_id":{"type":"string","description":"User ID autogenerated upon user creation"},"status":{"$ref":"#/components/schemas/Status"},"created_at":{"type":"number","description":"Date user was created in the tenant"},"updated_at":{"type":"number","description":"Date user was last updated"},"last_auth":{"format":"date-time","type":"string","description":"Date user last authenticated"},"roles":{"description":"User roles list","type":"array","items":{"$ref":"#/components/schemas/ApiAssignedRolesData"}}},"required":["user_id","status","created_at","updated_at"]}},"components/schemas/CreateAdminInput":{"id":"components/schemas/CreateAdminInput","kind":"json-schema","title":"CreateAdminInput","data":{"type":"object","properties":{"email":{"type":"string"},"roles":{"title":"Admin roles","description":"Roles to assign to the admin","type":"array","items":{"type":"string"}}},"required":["email","roles"]}},"components/schemas/ApiUser":{"id":"components/schemas/ApiUser","kind":"json-schema","title":"ApiUser","data":{"type":"object","properties":{"email":{"description":"Primary email address, used as user identifier","allOf":[{"$ref":"#/components/schemas/ApiUserEmail"}]},"secondary_emails":{"type":"array","items":{"$ref":"#/components/schemas/ApiUserEmail"}},"phone_number":{"description":"Primary phone number, used as user identifier","allOf":[{"$ref":"#/components/schemas/ApiUserPhone"}]},"secondary_phone_numbers":{"type":"array","items":{"$ref":"#/components/schemas/ApiUserPhone"}},"username":{"type":"string","description":"Username used to identify the user for password login (unless a primary email will be used instead). Defined only if a password was set for the user."},"user_id":{"type":"string","description":"User ID autogenerated upon user creation"},"birthday":{"format":"date-time","type":"string","description":"Birthday as YYYY-MM-DD"},"address":{"description":"User's address","allOf":[{"$ref":"#/components/schemas/ApiAddress"}]},"name":{"description":"Full name","allOf":[{"$ref":"#/components/schemas/ApiUserName"}]},"status":{"$ref":"#/components/schemas/Status"},"status_changed_at":{"format":"date-time","type":"string","description":"Date status was last updated"},"created_at":{"type":"number","description":"Date user was created in the tenant"},"updated_at":{"type":"number","description":"Date user was last updated"},"identity_providers":{"deprecated":true,"type":"array","items":{"$ref":"#/components/schemas/ApiUserIdentityProvider"}},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ApiUserIdentity"}},"last_auth":{"format":"date-time","type":"string","description":"Date user last authenticated"},"external_account_id":{"type":"string","description":"User identifier in an app, set by the app"},"app_name":{"type":"string","description":"Name of the app the user is associated with"},"custom_app_data":{"type":"object","description":"Custom data object for app-related user info"},"groupIds":{"description":"List of group IDs the user is assigned to","type":"array","items":{"type":"string"}},"picture":{"type":"string","description":"The picture of user, specified as a URL"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The language of the user, as provided by the browser using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc7231#section-5.3.5"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accept-Language"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header field"},"children":[]}]}]}]},"custom_data":{"type":"object","description":"Custom data object for tenant user info"},"external_user_id":{"type":"string","description":"A unique identifier in a tenant"},"password_information":{"description":"The information of the user's password","allOf":[{"$ref":"#/components/schemas/ApiPasswordInformation"}]},"custom_user_fields":{"type":"object","description":"Custom user fields defined by the tenant schema"}},"required":["user_id","status","created_at","updated_at"]}},"components/schemas/Status":{"id":"components/schemas/Status","kind":"json-schema","title":"Status","data":{"type":"string","enum":["Active","Disabled","Pending"]}},"components/schemas/ApiAssignedRolesData":{"id":"components/schemas/ApiAssignedRolesData","kind":"json-schema","title":"ApiAssignedRolesData","data":{"type":"object","properties":{"role_id":{"type":"string","description":"Role ID"}},"required":["role_id"]}},"components/schemas/ApiUserEmail":{"id":"components/schemas/ApiUserEmail","kind":"json-schema","title":"ApiUserEmail","data":{"type":"object","properties":{"value":{"type":"string","description":"Email address"},"email_verified":{"type":"boolean","description":"Indicates if email was verified (via magic link, social login, or email verification flows)"},"verified_at":{"format":"date-time","type":"string","description":"Last verification date of the email"}},"required":["value"]}},"components/schemas/ApiUserPhone":{"id":"components/schemas/ApiUserPhone","kind":"json-schema","title":"ApiUserPhone","data":{"type":"object","properties":{"value":{"type":"string","description":"Phone number"},"phone_number_verified":{"type":"boolean","description":"Indicates if phone number was verified (via SMS OTP or verification flow)"},"verified_at":{"format":"date-time","type":"string","description":"Last verification date of the phone number"}},"required":["value"]}},"components/schemas/ApiUserIdentityProvider":{"id":"components/schemas/ApiUserIdentityProvider","kind":"json-schema","title":"ApiUserIdentityProvider","data":{"type":"object","properties":{"source":{"type":"string","description":"Type of identity provider","enum":["UserID","BindID","Google","Apple","Facebook","Line","Tiktok","Transmit Identity","Transmit Security","BindIDApi","Email OTP","SMS OTP","Direct OTP","Email Magic Link","Password","Orchestrated","SAML","SSO OIDC","Mobile Biometrics","totp","face"]},"identifier":{"type":"string","description":"Identifier of the user in the provider's system"},"email":{"type":"string","description":"Email used by the user to authenticate to this provider"},"first_auth_date":{"format":"date-time","type":"string","description":"Date user first authenticated to this provider"},"last_auth_date":{"format":"date-time","type":"string","description":"Date user last authenticated to this provider"}},"required":["source","identifier","email","first_auth_date","last_auth_date"]}},"components/schemas/ApiUserIdentity":{"id":"components/schemas/ApiUserIdentity","kind":"json-schema","title":"ApiUserIdentity","data":{"type":"object","properties":{"provider_name":{"type":"string","description":"Name of identity provider"},"provider_type":{"type":"string","description":"Indicates whether the identity provider is Transmit (Native) or a social login provider (OAuth2)","enum":["OAuth2","Native","External"]},"auth_type":{"type":"string","enum":["webauthn","email_otp","sms_otp","direct_otp","email_magic_link","password","oauth2","saml","transmit","totp"],"description":"Type of authentication method that was used"},"identifier":{"type":"string","description":"Identifier of the user in the provider's system"},"user_alias":{"description":"Alias used by the user to authenticate to this provider","allOf":[{"$ref":"#/components/schemas/ApiUserIdentityAlias"}]},"first_auth_date":{"format":"date-time","type":"string","description":"Date user first authenticated to this provider"},"last_auth_date":{"format":"date-time","type":"string","description":"Date user last authenticated to this provider"}},"required":["provider_name","provider_type","auth_type","identifier","first_auth_date","last_auth_date"]}},"components/schemas/ApiAddress":{"id":"components/schemas/ApiAddress","kind":"json-schema","title":"ApiAddress","data":{"type":"object","properties":{"country":{"type":"string","description":"Country","maximum":30},"state":{"type":"string","description":"State","maximum":30},"city":{"type":"string","description":"City","maximum":30},"street_address":{"type":"string","description":"Street address","maximum":150},"postal_code":{"type":"string","description":"Postal code","maximum":30},"type":{"$ref":"#/components/schemas/AddressType"},"updated_at":{"type":"number","description":"Date user's address was last updated"}}}},"components/schemas/ApiUserName":{"id":"components/schemas/ApiUserName","kind":"json-schema","title":"ApiUserName","data":{"type":"object","properties":{"title":{"type":"string","description":"Title","maximum":30},"first_name":{"type":"string","description":"User's first name","maximum":30},"last_name":{"type":"string","description":"User's last name","maximum":30},"middle_name":{"type":"string","description":"User's middle name","maximum":30}}}},"components/schemas/ApiPasswordInformation":{"id":"components/schemas/ApiPasswordInformation","kind":"json-schema","title":"ApiPasswordInformation","data":{"type":"object","properties":{"expired":{"type":"boolean","description":"Whether the password is currently expired"},"temporary":{"type":"boolean","description":"Whether the password must be reset after first use"},"updated_at":{"type":"number","description":"The date the password was last updated, as unix epoch in milliseconds"},"expires_in":{"format":"date-time","type":"string","description":"The date the password will be expired"}},"required":["expired","temporary","updated_at"]}},"components/schemas/AddressType":{"id":"components/schemas/AddressType","kind":"json-schema","title":"AddressType","data":{"type":"string","enum":["Home","Work","Other"]}},"components/schemas/ApiUserIdentityAlias":{"id":"components/schemas/ApiUserIdentityAlias","kind":"json-schema","title":"ApiUserIdentityAlias","data":{"type":"object","properties":{"type":{"type":"string","description":"Alias type, which varies based on authentication method","enum":["username","email","phone_number","unspecified"]},"value":{"type":"string","description":"Alias value"}},"required":["type","value"]}},"schema_305":{"kind":"json-schema","data":{"title":"ApiOkResponse-createOrAssignAdminUser","type":"object","required":["result"],"description":"Admin added successfully","properties":{"result":{"$ref":"#/components/schemas/ApiUser"}}},"id":"schema_305"},"schema_306":{"kind":"json-schema","data":{"title":"ApiOkResponse-getAdminUsers","type":"object","required":["result"],"description":"A list of admin users","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ApiAdminUser"}}}},"id":"schema_306"},"schema_307":{"kind":"json-schema","data":{"type":"string"},"id":"schema_307"}},"exampleStore":{},"securitySchemeStore":{"bearer":{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"},"UserAccessToken":{"id":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated"},"AdminAccessToken":{"id":"AdminAccessToken","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by a management application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to all resources for the tenant and its apps"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}},"ClientAccessToken":{"id":"ClientAccessToken","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}},"OrgAdminAccessToken":{"id":"OrgAdminAccessToken","type":"oauth2","description":"A token returned upon B2B authentication for a user that has the organizationAdmin or organizationCreator role.","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}},"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}]},"options":{"corsProxyUrl":"https://cors.redoc.ly","hideSchemaTitles":true,"onlyRequiredInSamples":false,"hideDownloadButtons":false,"codeSamples":{"skipOptionalParameters":false,"languages":[{"lang":"curl","label":"cURL"},{"lang":"Node.js"},{"lang":"Go"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"Python"}]},"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/user/admin-users.openapi.json?download"},{"url":"/_bundle/openapi/user/admin-users.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Admin users","description":"Manage admin user profiles"}},"baseSlug":"/openapi/user/admin-users.openapi","routesMapping":{}}