Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
z) Global Functionality

Create a global admin user

Creates a user that can operate across all tenants. For PKI authentication, generate an RSA key pair with openssl and supply the base64-encoded public key.

post/eclipse-conductor/rest/v1/global/admin-users

Request body

base64EncodedPublicKeystring

An optional PKI RSA public key for added security. If a public key is provided then the PKI login-challenges endpoint should be used to get a challenge to respond to as part of the login

emailstring

Users email address

firstNamestring

Customers middle name

identitystring required

Identity/username for authentication

institutionstring

Optional. The accountable institution that the admin user falls under - making them INSTITUTION admin users

lastNamestring required

Customers last/family name

passwordstring

Can be pre-hashed with BCRYPT or passed as clear text in which case Eclipse will hash it

phone1string required

Tenants primary phone number

role'GLOBAL_ADMIN' | 'GLOBAL_CICD' | 'GLOBAL_COMPLIANCE_L_1' | 'GLOBAL_FINANCE_L_1' | 'GLOBAL_FINANCE_L_2' | 'GLOBAL_FINANCE_L_3' | 'GLOBAL_INTEGRATOR' | 'GLOBAL_SUPPORT_L_1' | 'GLOBAL_SUPPORT_L_2' | 'GLOBAL_SUPPORT_L_3' | 'GLOBAL_TECH_SUPPORT' | 'INSTITUTION_ADMIN' | 'INSTITUTION_FINANCE_L_1' | 'INSTITUTION_FINANCE_L_2' | 'INSTITUTION_FINANCE_L_3' | 'INSTITUTION_INTEGRATOR' | 'INSTITUTION_SUPPORT_L_1' | 'INSTITUTION_SUPPORT_L_2' | 'INSTITUTION_SUPPORT_L_3' | 'INSTITUTION_TECH_SUPPORT'
ssoEnabledboolean

Indicates that this identity is purely for single sign on (e.g. SAML/OIDC) and cannot be used for authentication. If SSO is enabled then TOTP must be disabled and base64EncodedPublicKey and password should not be provided

totpEnabledboolean

Whether this identity will require a time base one time password when authenticating

userTypeIdinteger

Response

OK

adminUserIdinteger

Unique system generated identifier for an admin user

base64EncodedPublicKeystring

An optional PKI RSA public key for added security. If a public key is provided then the PKI login-challenges endpoint should be used to get a challenge to respond to as part of the login

emailstring

Users email address

firstNamestring

Customers middle name

identitystring required

Identity/username for authentication

institutionstring

Optional. The accountable institution that the admin user falls under - making them INSTITUTION admin users

lastNamestring required

Customers last/family name

phone1string required

Users primary phone number

role'GLOBAL_ADMIN' | 'GLOBAL_CICD' | 'GLOBAL_COMPLIANCE_L_1' | 'GLOBAL_FINANCE_L_1' | 'GLOBAL_FINANCE_L_2' | 'GLOBAL_FINANCE_L_3' | 'GLOBAL_INTEGRATOR' | 'GLOBAL_SUPPORT_L_1' | 'GLOBAL_SUPPORT_L_2' | 'GLOBAL_SUPPORT_L_3' | 'GLOBAL_TECH_SUPPORT' | 'INSTITUTION_ADMIN' | 'INSTITUTION_FINANCE_L_1' | 'INSTITUTION_FINANCE_L_2' | 'INSTITUTION_FINANCE_L_3' | 'INSTITUTION_INTEGRATOR' | 'INSTITUTION_SUPPORT_L_1' | 'INSTITUTION_SUPPORT_L_2' | 'INSTITUTION_SUPPORT_L_3' | 'INSTITUTION_TECH_SUPPORT'
ssoEnabledboolean

Indicates that this identity is purely for single sign on (e.g. SAML/OIDC) and cannot be used for authentication. If SSO is enabled then TOTP must be disabled and base64EncodedPublicKey and password should not be provided

totpEnabledboolean

Whether this identity will require a time base one time password when authenticating

totpQrCodestring

The QRCode which can be scanned with any RFC 6238 compliant App (E.g. Google Authenticator). Only provided in response to the enabling or resetting of TOTP

userTypeIdinteger