AM Logo
API AuthorizationAPI DocumentationForm DefinitionsFAQ
  1. Home
  3. API Documentation
  5. Identity
  7. Mutations

Mutations

List of available mutations.

acknowledge (

announcementId: UUID!,

hasBeenAccepted: Boolean!,

signatureBase64: String,

): AnnouncementDisplayHistory!
Acnowledges an announcement.
addTenantUserAccountApplicationLease (

tenantId: UUID!,

userId: UUID!,

applicationId: UUID,

applicationPublicId: String,

): TenantApplicationLeaseUserAccount!
Enables User, that is already in tenancy, to access Application leased by that Tenancy.
addTenantUserExternalId (

tenantId: UUID!,

userId: UUID!,

externalId: TenantUserAccountExternalIdInput!,

): TenantUserAccountExternalId!
Adds external identifier to User Account within Tenancy.
addUserAccountMultiFactorAuthenticationMethod (

method: UserAccountMultiFactorAuthenticationMethodInput!,

): UserAccountMultiFactorAuthenticationMethod!
Configures new multi-factor authentication method for User Account.
addUserToTenancy (

tenantId: UUID!,

userId: UUID!,

): TenantUserAccount!
Adds user account to given tenancy.
changeTenantApiClientSecretKey (

apiClientId: UUID!,

secretKey: String!,

): TenantApplicationLeaseApiClient!
Sets new secret key of API Client.
changeTenantCulture (

tenantId: UUID!,

culture: CultureInfo,

): Tenant!
Changes Tenant's culture and language.
changeTenantTimeZone (

tenantId: UUID!,

timeZone: TimeZoneInfo,

): Tenant!
Changes Tenant's time zone.
changeUserAccountCellPhoneNumber (

userId: UUID!,

cellPhoneNumber: String!,

): UserAccount!
Sets new cell phone number for given User Account.
changeUserAccountCulture (

userId: UUID!,

culture: CultureInfo,

): UserAccount!
Changes User Account's culture and language.
changeUserAccountEmailAddress (

userId: UUID!,

emailAddress: String!,

): UserAccount!
Sets new e-mail address for given User Account.
changeUserAccountPassword (

userId: UUID!,

password: String!,

): UserAccount!
Sets new password for given User Account.
changeUserAccountTimeZone (

userId: UUID!,

timeZone: TimeZoneInfo,

): UserAccount!
Changes User Account's time zone.
clearUserAccountMultiFactorAuthenticationBypasses (

userId: UUID!,

): UserAccount!
configureTenantUserAccountApplicationLeaseSuperAdminFlag (

tenantId: UUID!,

userId: UUID!,

applicationId: UUID,

applicationPublicId: String,

isSuperAdmin: Boolean!,

): Boolean!
configureUserAccountGlobalSuperAdminFlag (

userId: UUID!,

isSuperAdmin: Boolean!,

): Boolean!
createAnnouncement (

announcement: AnnouncementInput!,

announcementScopeInput: AnnouncementScopeInput,

): Announcement!
Creates new Announcement.
createApplication (

application: ApplicationInput!,

): Application!
Creates new Qualo Application.
createApplicationClient (

applicationId: UUID!,

client: ApplicationClientInput!,

): ApplicationClient!
Creates new Qualo Application Client.
createApplicationLease (

lease: TenantApplicationLeaseInput!,

): TenantApplicationLease!
Creates new Application Lease for given Tenant. Allowing that Tenant to use that Application.
createExternalIdentityConsumer (

consumer: ExternalIdentityConsumerInput!,

attributesMapping: [ExternalIdentityConsumerAttributesMappingInput!],

extraConfiguration: ExternalIdentityConsumerExtraConfigurationInput,

): ExternalIdentityConsumer!
Creates new External Identity Consumer.
createTemporalAuthenticationCode (

code: UserAccountTemporalAuthenticationCodeInput!,

): UserAccountTemporalAuthenticationCode!
createTenant (

tenant: TenantInput!,

): Tenant!
Creates new Tenant.
createTenantApiClient (

apiClient: TenantApplicationLeaseApiClientInput!,

tenantId: UUID,

): TenantApplicationLeaseApiClient!
Creates new API Client for given Application and Tenant.
createTenantApiClientAccessControlRule (

apiClientId: UUID!,

rule: AccessControlRuleInput!,

): TenantApplicationLeaseApiClientAccessControlRule!
Creates new access control rule for API Client of an Tenant.
createTenantApplicationLeaseUserAccountAccessControlRule (

tenantId: UUID!,

userId: UUID!,

applicationId: UUID,

applicationPublicId: String,

rule: AccessControlRuleInput!,

): TenantApplicationLeaseUserAccountAccessControlRule!
Creates new Application access control rule for User Account within Tenancy.
createUserAccount (

userAccount: UserAccountInput!,

updateExisting: Boolean!,

): UserAccount!
Creates new Qualo User Account.
deleteAnnouncement (

announcementId: UUID!,

soft: Boolean!,

): Boolean!
Deletes announcements.
deleteApplication (

applicationId: UUID!,

): Boolean!
Removes Qualo Application.
deleteApplicationClient (

clientId: UUID!,

): Boolean!
Removes Qualo Application Client.
deleteExternalIdentityConsumer (

consumerId: UUID!,

): Boolean!
Removes External Identity Consumer.
deleteTenant (

tenantId: UUID!,

): Boolean!
Deletes existing Tenant, locking it out from the system (reversable).
deleteTenantApiClient (

apiClientId: UUID!,

): Boolean!
Deleted API Client.
deleteTenantUserExternalId (

externalIdId: UUID!,

): Boolean!
Removes external identifier of User Account within Tenancy.
deleteUserAccount (

userId: UUID!,

): Boolean!
Deletes existing Qualo User Account (reversable).
disableExternalIdentityConsumer (

consumerId: UUID!,

): Boolean!
Disables External Identity Consumer.
enableExternalIdentityConsumer (

consumerId: UUID!,

): Boolean!
Enables External Identity Consumer.
findAndRemoveTemporalAuthenticationCode (

filterBy: [UserAccountTemporalAuthenticationCodeFilterInput!]!,

): Int!
hardDeleteTenant (

tenantId: UUID!,

): Boolean!
Deletes existing Tenant, locking it out from the system (non-reversable, Tenant alongside all its data is physically removed from the system).
hardDeleteUserAccount (

userId: UUID!,

): Boolean!
Deletes existing Qualo User Account (non-reversable, whole data of this user will be physically wiped out from the system).
inviteUserToTenancy (

tenantId: UUID!,

emailAddress: String!,

): UUID!
Invites user (existing or not) to given tenancy. **Returns:** Identifier of the invitation.
liftTenantApiClientLockdown (

apiClientId: UUID!,

): TenantApplicationLeaseApiClient!
Removes previously set lockdown of API Client.
liftUserAccountLockdown (

userId: UUID!,

): UserAccount!
Removes previously set lockdown of User Account.
lockdownTenantApiClient (

apiClientId: UUID!,

lockdownEnd: DateTime,

): TenantApplicationLeaseApiClient!
Disables API Client, rendering it unable to be login and be used with Qualo.
lockdownUserAccount (

userId: UUID!,

lockdownEnd: DateTime,

): UserAccount!
Disables User Account, rendering it unable to be login and be used with Qualo.
removeAccessControlRule (

ruleId: UUID!,

): Boolean!
Deletes existing Application access control rule for User Account within Tenancy.
removeApplicationLease (

lease: TenantApplicationLeaseInput!,

): Boolean!
Removes Application Lease from given Tenant. Locks ability to use the Application by Tenant.
removeTemporalAuthenticationCode (

codeId: [UUID!]!,

): Boolean!
removeTenantApiClientAccessControlRule (

ruleId: UUID!,

): Boolean!
Deletes existing access control rule of API Client of an Tenant.
removeTenantUserAccountApplicationLease (

tenantId: UUID!,

userId: UUID!,

applicationId: UUID,

applicationPublicId: String,

): Boolean!
Disables User, that is in tenancy, from accessing Application leased by that Tenancy.
removeUserAccountMultiFactorAuthenticationMethod (

methodId: UUID!,

): Boolean!
Removes existing multi-factor authentication method from User Account's configuration.
removeUserFromTenancy (

tenantId: UUID!,

userId: UUID!,

): Boolean!
Removes user account from given tenancy.
resetTenantApplicationLeaseUserAccountDeactivationDate (

tenantId: UUID!,

userId: UUID!,

applicationId: UUID,

applicationPublicId: String,

recalculate: Boolean!,

): Boolean!
Reset tenant application user account deactivation date.
resetTenantUserAccountDeactivationDate (

tenantId: UUID!,

userId: UUID!,

recalculate: Boolean!,

): Boolean!
Reset tenant user account deactivation date.
sendPasswordResetEmail (

userId: UUID!,

): Boolean!
Sends a new password recovery e-mail for given User Account.
setExternalIdentityConsumerAttributesMapping (

consumerId: UUID!,

attributesMapping: [ExternalIdentityConsumerAttributesMappingInput!],

): Boolean!
Sets security configuration of existing External Identity Consumer.
setExternalIdentityConsumerExtraConfiguration (

consumerId: UUID!,

extraConfiguration: ExternalIdentityConsumerExtraConfigurationInput!,

): Boolean!
Sets security configuration of existing External Identity Consumer.
setTenantAccountActivityPeriod (

tenantId: UUID!,

accountActivity: TenantAccountActivityInput!,

): Boolean!
Set tenant account activity period.
setTenantApplicationLeaseAccountActivityPeriod (

leaseAccountActivity: TenantApplicationLeaseAccountActivityInput!,

): Boolean!
Set tenant application account activity period.
setTenantApplicationLeaseUserAccountDeactivationDate (

tenantId: UUID!,

userId: UUID!,

applicationId: UUID,

applicationPublicId: String,

deactivationDate: DateTime!,

): Boolean!
Set tenant application user account deactivation date.
setTenantUserAccountDeactivationDate (

tenantId: UUID!,

userId: UUID!,

deactivationDate: DateTime!,

): Boolean!
Set tenant user account deactivation date.
setUserAccountGlobalPermissions (

userId: UUID!,

permissions: PermissionsSheetInputTypeOfGlobalPermissionsSheetInput,

): GlobalPermissionsSheet!
Sets global permissions of User Account.
setUserAccountLocalPermissions (

tenantId: UUID!,

userId: UUID!,

permissions: PermissionsSheetInputTypeOfTenantLocalPermissionsSheetInput,

): TenantLocalPermissionsSheet!
Sets global permissions of User Account.
undeleteTenant (

tenantId: UUID!,

): Boolean!
Undeletes existing Tenant, unlocking it back into the system (reversable).
undeleteUserAccount (

userId: UUID!,

): Boolean!
Deletes existing Qualo User Account (reversable).
updateApplication (

applicationId: UUID!,

application: ApplicationInput!,

): Application!
Updates configuration of existing Qualo Application.
updateApplicationClient (

clientId: UUID!,

client: ApplicationClientInput!,

): ApplicationClient!
Updates configuration of existing Qualo Application Client.
updateContents (

announcementId: UUID!,

content: String!,

): Announcement!
Updates Announcement contents.
updateDisplaySchedule (

announcementId: UUID!,

validTo: DateTime,

displaySchedule: CrontabSchedule,

): Announcement!
Updates Announcement display schedule.
updateExternalIdentityConsumer (

consumerId: UUID!,

consumer: ExternalIdentityConsumerInput!,

): ExternalIdentityConsumer!
Updates configuration of existing External Identity Consumer.
updateTenant (

tenantId: UUID!,

tenant: TenantInput!,

): Tenant!
Updates existing Tenant's basic configuration.
updateTenantApiClient (

apiClientId: UUID!,

apiClient: TenantApplicationLeaseApiClientUpdateInput!,

): TenantApplicationLeaseApiClient!
Updates configuration of API Client.
updateTenantApiClientAccessControlRule (

ruleId: UUID!,

rule: AccessControlRuleInput!,

): TenantApplicationLeaseApiClientAccessControlRule!
Updates existing access control rule of API Client of an Tenant.
updateTenantApplicationLeaseUserAccountAccessControlRule (

ruleId: UUID!,

rule: AccessControlRuleInput!,

): TenantApplicationLeaseUserAccountAccessControlRule!
Updates existing Application access control rule for User Account within Tenancy.
updateTenantUserExternalId (

externalIdId: UUID!,

externalId: TenantUserAccountExternalIdInput!,

): TenantUserAccountExternalId!
Updates external identifier of User Account within Tenancy.
updateUserAccount (

userId: UUID!,

userAccount: UserAccountInput!,

): UserAccount!
Updates existing Qualo User Account's basic data.