Nexus

Nexus APIs

PATCH /v1/users/{userId}

Updates the given properties on a User.

This operation can be used to link an existing User to an existing IdP user by providing the idpUserId.

This operation only updates an attribute if is provided with a non-NULL value.

Updating a password requires the user.password permission.

Updating attributes requires the user.write permission

Parameters
Name In Required Description
userId path Yes —
Request body
Request payload
Example 
{
  "picture": "string",
  "language": "string",
  "nickname": "string",
  "password": "string",
  "username": "justin",
  "givenName": "string",
  "isBlocked": false,
  "familyName": "string",
  "displayName": "Justin Buchanan",
  "phoneNumber": "string",
  "emailVerified": false,
  "isMfaDisabled": false,
  "emailVerifySentDate": "string",
  "mfaEnrollmentStatus": "string",
  "recoveryEmailAddress": "justin@example.com"
}
Schema
Name Type Attributes Description Extensions
displayName string nullable A display name to use when showing the user information to admins and other users.
maxLength: 200
 —
emailVerified boolean nullable A emailVerificationStatus for the user. —
emailVerifySentDate string (date-time) nullable An email verify sent date for the user. —
familyName string nullable The users family or last name.
maxLength: 100
 —
givenName string nullable The users given or first name.
maxLength: 100
 —
isBlocked boolean nullable A value that indicates if the user is blocked from signing in or not. This is not the same as being automatically blocked for brute-force attempts. —
isMfaDisabled boolean nullable Indicates if the user is required to use multi-factor authentication. This is only applicable if Nexus.Backend.Domain.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. —
language string nullable The preferred language for the user —
mfaEnrollmentStatus string nullable The user who owns the device. —
nickname string nullable A nickname for the user.
maxLength: 100
 —
password string nullable The initial password to configure for the user if password authentication. Required if passsword authentication is selected.
minLength: 8 · maxLength: 250
 —
phoneNumber string nullable A phone number for the user. This number may be used for SMS based MFA.
maxLength: 50
 —
picture string nullable A URL to a picture of the user.
maxLength: 250
 —
recoveryEmailAddress string nullable The user's email address. This value will be used as the primary method of recoverying an account or resetting their password. <list type="bullet"><item> This value must adhere to the format 'user@domain' </item><item> The email address is not validated (by default). </item></list>
maxLength: 250
 —
username string nullable The username that will be used to sign in the user, if different from their email address.
minLength: 4
 —
Example 
{
  "picture": "string",
  "language": "string",
  "nickname": "string",
  "password": "string",
  "username": "justin",
  "givenName": "string",
  "isBlocked": false,
  "familyName": "string",
  "displayName": "Justin Buchanan",
  "phoneNumber": "string",
  "emailVerified": false,
  "isMfaDisabled": false,
  "emailVerifySentDate": "string",
  "mfaEnrollmentStatus": "string",
  "recoveryEmailAddress": "justin@example.com"
}
Schema
Name Type Attributes Description Extensions
displayName string nullable A display name to use when showing the user information to admins and other users.
maxLength: 200
 —
emailVerified boolean nullable A emailVerificationStatus for the user. —
emailVerifySentDate string (date-time) nullable An email verify sent date for the user. —
familyName string nullable The users family or last name.
maxLength: 100
 —
givenName string nullable The users given or first name.
maxLength: 100
 —
isBlocked boolean nullable A value that indicates if the user is blocked from signing in or not. This is not the same as being automatically blocked for brute-force attempts. —
isMfaDisabled boolean nullable Indicates if the user is required to use multi-factor authentication. This is only applicable if Nexus.Backend.Domain.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. —
language string nullable The preferred language for the user —
mfaEnrollmentStatus string nullable The user who owns the device. —
nickname string nullable A nickname for the user.
maxLength: 100
 —
password string nullable The initial password to configure for the user if password authentication. Required if passsword authentication is selected.
minLength: 8 · maxLength: 250
 —
phoneNumber string nullable A phone number for the user. This number may be used for SMS based MFA.
maxLength: 50
 —
picture string nullable A URL to a picture of the user.
maxLength: 250
 —
recoveryEmailAddress string nullable The user's email address. This value will be used as the primary method of recoverying an account or resetting their password. <list type="bullet"><item> This value must adhere to the format 'user@domain' </item><item> The email address is not validated (by default). </item></list>
maxLength: 250
 —
username string nullable The username that will be used to sign in the user, if different from their email address.
minLength: 4
 —
Example 
{
  "picture": "string",
  "language": "string",
  "nickname": "string",
  "password": "string",
  "username": "justin",
  "givenName": "string",
  "isBlocked": false,
  "familyName": "string",
  "displayName": "Justin Buchanan",
  "phoneNumber": "string",
  "emailVerified": false,
  "isMfaDisabled": false,
  "emailVerifySentDate": "string",
  "mfaEnrollmentStatus": "string",
  "recoveryEmailAddress": "justin@example.com"
}
Schema
Name Type Attributes Description Extensions
displayName string nullable A display name to use when showing the user information to admins and other users.
maxLength: 200
 —
emailVerified boolean nullable A emailVerificationStatus for the user. —
emailVerifySentDate string (date-time) nullable An email verify sent date for the user. —
familyName string nullable The users family or last name.
maxLength: 100
 —
givenName string nullable The users given or first name.
maxLength: 100
 —
isBlocked boolean nullable A value that indicates if the user is blocked from signing in or not. This is not the same as being automatically blocked for brute-force attempts. —
isMfaDisabled boolean nullable Indicates if the user is required to use multi-factor authentication. This is only applicable if Nexus.Backend.Domain.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. —
language string nullable The preferred language for the user —
mfaEnrollmentStatus string nullable The user who owns the device. —
nickname string nullable A nickname for the user.
maxLength: 100
 —
password string nullable The initial password to configure for the user if password authentication. Required if passsword authentication is selected.
minLength: 8 · maxLength: 250
 —
phoneNumber string nullable A phone number for the user. This number may be used for SMS based MFA.
maxLength: 50
 —
picture string nullable A URL to a picture of the user.
maxLength: 250
 —
recoveryEmailAddress string nullable The user's email address. This value will be used as the primary method of recoverying an account or resetting their password. <list type="bullet"><item> This value must adhere to the format 'user@domain' </item><item> The email address is not validated (by default). </item></list>
maxLength: 250
 —
username string nullable The username that will be used to sign in the user, if different from their email address.
minLength: 4
 —
Example 
{
  "picture": "string",
  "language": "string",
  "nickname": "string",
  "password": "string",
  "username": "justin",
  "givenName": "string",
  "isBlocked": false,
  "familyName": "string",
  "displayName": "Justin Buchanan",
  "phoneNumber": "string",
  "emailVerified": false,
  "isMfaDisabled": false,
  "emailVerifySentDate": "string",
  "mfaEnrollmentStatus": "string",
  "recoveryEmailAddress": "justin@example.com"
}
Schema
Name Type Attributes Description Extensions
displayName string nullable A display name to use when showing the user information to admins and other users.
maxLength: 200
 —
emailVerified boolean nullable A emailVerificationStatus for the user. —
emailVerifySentDate string (date-time) nullable An email verify sent date for the user. —
familyName string nullable The users family or last name.
maxLength: 100
 —
givenName string nullable The users given or first name.
maxLength: 100
 —
isBlocked boolean nullable A value that indicates if the user is blocked from signing in or not. This is not the same as being automatically blocked for brute-force attempts. —
isMfaDisabled boolean nullable Indicates if the user is required to use multi-factor authentication. This is only applicable if Nexus.Backend.Domain.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. —
language string nullable The preferred language for the user —
mfaEnrollmentStatus string nullable The user who owns the device. —
nickname string nullable A nickname for the user.
maxLength: 100
 —
password string nullable The initial password to configure for the user if password authentication. Required if passsword authentication is selected.
minLength: 8 · maxLength: 250
 —
phoneNumber string nullable A phone number for the user. This number may be used for SMS based MFA.
maxLength: 50
 —
picture string nullable A URL to a picture of the user.
maxLength: 250
 —
recoveryEmailAddress string nullable The user's email address. This value will be used as the primary method of recoverying an account or resetting their password. <list type="bullet"><item> This value must adhere to the format 'user@domain' </item><item> The email address is not validated (by default). </item></list>
maxLength: 250
 —
username string nullable The username that will be used to sign in the user, if different from their email address.
minLength: 4
 —
Example 
{
  "picture": "string",
  "language": "string",
  "nickname": "string",
  "password": "string",
  "username": "justin",
  "givenName": "string",
  "isBlocked": false,
  "familyName": "string",
  "displayName": "Justin Buchanan",
  "phoneNumber": "string",
  "emailVerified": false,
  "isMfaDisabled": false,
  "emailVerifySentDate": "string",
  "mfaEnrollmentStatus": "string",
  "recoveryEmailAddress": "justin@example.com"
}
Schema
Name Type Attributes Description Extensions
displayName string nullable A display name to use when showing the user information to admins and other users.
maxLength: 200
 —
emailVerified boolean nullable A emailVerificationStatus for the user. —
emailVerifySentDate string (date-time) nullable An email verify sent date for the user. —
familyName string nullable The users family or last name.
maxLength: 100
 —
givenName string nullable The users given or first name.
maxLength: 100
 —
isBlocked boolean nullable A value that indicates if the user is blocked from signing in or not. This is not the same as being automatically blocked for brute-force attempts. —
isMfaDisabled boolean nullable Indicates if the user is required to use multi-factor authentication. This is only applicable if Nexus.Backend.Domain.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. —
language string nullable The preferred language for the user —
mfaEnrollmentStatus string nullable The user who owns the device. —
nickname string nullable A nickname for the user.
maxLength: 100
 —
password string nullable The initial password to configure for the user if password authentication. Required if passsword authentication is selected.
minLength: 8 · maxLength: 250
 —
phoneNumber string nullable A phone number for the user. This number may be used for SMS based MFA.
maxLength: 50
 —
picture string nullable A URL to a picture of the user.
maxLength: 250
 —
recoveryEmailAddress string nullable The user's email address. This value will be used as the primary method of recoverying an account or resetting their password. <list type="bullet"><item> This value must adhere to the format 'user@domain' </item><item> The email address is not validated (by default). </item></list>
maxLength: 250
 —
username string nullable The username that will be used to sign in the user, if different from their email address.
minLength: 4
 —
Example 
{
  "picture": "string",
  "language": "string",
  "nickname": "string",
  "password": "string",
  "username": "justin",
  "givenName": "string",
  "isBlocked": false,
  "familyName": "string",
  "displayName": "Justin Buchanan",
  "phoneNumber": "string",
  "emailVerified": false,
  "isMfaDisabled": false,
  "emailVerifySentDate": "string",
  "mfaEnrollmentStatus": "string",
  "recoveryEmailAddress": "justin@example.com"
}
Schema
Name Type Attributes Description Extensions
displayName string nullable A display name to use when showing the user information to admins and other users.
maxLength: 200
 —
emailVerified boolean nullable A emailVerificationStatus for the user. —
emailVerifySentDate string (date-time) nullable An email verify sent date for the user. —
familyName string nullable The users family or last name.
maxLength: 100
 —
givenName string nullable The users given or first name.
maxLength: 100
 —
isBlocked boolean nullable A value that indicates if the user is blocked from signing in or not. This is not the same as being automatically blocked for brute-force attempts. —
isMfaDisabled boolean nullable Indicates if the user is required to use multi-factor authentication. This is only applicable if Nexus.Backend.Domain.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. —
language string nullable The preferred language for the user —
mfaEnrollmentStatus string nullable The user who owns the device. —
nickname string nullable A nickname for the user.
maxLength: 100
 —
password string nullable The initial password to configure for the user if password authentication. Required if passsword authentication is selected.
minLength: 8 · maxLength: 250
 —
phoneNumber string nullable A phone number for the user. This number may be used for SMS based MFA.
maxLength: 50
 —
picture string nullable A URL to a picture of the user.
maxLength: 250
 —
recoveryEmailAddress string nullable The user's email address. This value will be used as the primary method of recoverying an account or resetting their password. <list type="bullet"><item> This value must adhere to the format 'user@domain' </item><item> The email address is not validated (by default). </item></list>
maxLength: 250
 —
username string nullable The username that will be used to sign in the user, if different from their email address.
minLength: 4
 —
Example 
{
  "picture": "string",
  "language": "string",
  "nickname": "string",
  "password": "string",
  "username": "justin",
  "givenName": "string",
  "isBlocked": false,
  "familyName": "string",
  "displayName": "Justin Buchanan",
  "phoneNumber": "string",
  "emailVerified": false,
  "isMfaDisabled": false,
  "emailVerifySentDate": "string",
  "mfaEnrollmentStatus": "string",
  "recoveryEmailAddress": "justin@example.com"
}
Schema
Name Type Attributes Description Extensions
displayName string nullable A display name to use when showing the user information to admins and other users.
maxLength: 200
 —
emailVerified boolean nullable A emailVerificationStatus for the user. —
emailVerifySentDate string (date-time) nullable An email verify sent date for the user. —
familyName string nullable The users family or last name.
maxLength: 100
 —
givenName string nullable The users given or first name.
maxLength: 100
 —
isBlocked boolean nullable A value that indicates if the user is blocked from signing in or not. This is not the same as being automatically blocked for brute-force attempts. —
isMfaDisabled boolean nullable Indicates if the user is required to use multi-factor authentication. This is only applicable if Nexus.Backend.Domain.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. —
language string nullable The preferred language for the user —
mfaEnrollmentStatus string nullable The user who owns the device. —
nickname string nullable A nickname for the user.
maxLength: 100
 —
password string nullable The initial password to configure for the user if password authentication. Required if passsword authentication is selected.
minLength: 8 · maxLength: 250
 —
phoneNumber string nullable A phone number for the user. This number may be used for SMS based MFA.
maxLength: 50
 —
picture string nullable A URL to a picture of the user.
maxLength: 250
 —
recoveryEmailAddress string nullable The user's email address. This value will be used as the primary method of recoverying an account or resetting their password. <list type="bullet"><item> This value must adhere to the format 'user@domain' </item><item> The email address is not validated (by default). </item></list>
maxLength: 250
 —
username string nullable The username that will be used to sign in the user, if different from their email address.
minLength: 4
 —
Example 
{
  "picture": "string",
  "language": "string",
  "nickname": "string",
  "password": "string",
  "username": "justin",
  "givenName": "string",
  "isBlocked": false,
  "familyName": "string",
  "displayName": "Justin Buchanan",
  "phoneNumber": "string",
  "emailVerified": false,
  "isMfaDisabled": false,
  "emailVerifySentDate": "string",
  "mfaEnrollmentStatus": "string",
  "recoveryEmailAddress": "justin@example.com"
}
Schema
Name Type Attributes Description Extensions
displayName string nullable A display name to use when showing the user information to admins and other users.
maxLength: 200
 —
emailVerified boolean nullable A emailVerificationStatus for the user. —
emailVerifySentDate string (date-time) nullable An email verify sent date for the user. —
familyName string nullable The users family or last name.
maxLength: 100
 —
givenName string nullable The users given or first name.
maxLength: 100
 —
isBlocked boolean nullable A value that indicates if the user is blocked from signing in or not. This is not the same as being automatically blocked for brute-force attempts. —
isMfaDisabled boolean nullable Indicates if the user is required to use multi-factor authentication. This is only applicable if Nexus.Backend.Domain.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. —
language string nullable The preferred language for the user —
mfaEnrollmentStatus string nullable The user who owns the device. —
nickname string nullable A nickname for the user.
maxLength: 100
 —
password string nullable The initial password to configure for the user if password authentication. Required if passsword authentication is selected.
minLength: 8 · maxLength: 250
 —
phoneNumber string nullable A phone number for the user. This number may be used for SMS based MFA.
maxLength: 50
 —
picture string nullable A URL to a picture of the user.
maxLength: 250
 —
recoveryEmailAddress string nullable The user's email address. This value will be used as the primary method of recoverying an account or resetting their password. <list type="bullet"><item> This value must adhere to the format 'user@domain' </item><item> The email address is not validated (by default). </item></list>
maxLength: 250
 —
username string nullable The username that will be used to sign in the user, if different from their email address.
minLength: 4
 —
Responses
200
Example 
{
  "id": "string",
  "type": "string",
  "owner": {
    "id": "string",
    "type": "string",
    "owner": {
      "id": "string",
      "type": "string",
      "owner": {
        "type": null,
        "owner": null,
        "organization": null,
        "authenticationMethod": null,
        "email-verification-status-type": null
      },
      "roles": [],
      "created": "string",
      "ownerId": "string",
      "picture": "string",
      "isActive": false,
      "language": "string",
      "memberOf": [],
      "modified": "string",
      "nickname": "string",
      "username": "string",
      "createdBy": "string",
      "givenName": "string",
      "attributes": [],
      "customUpns": [],
      "familyName": "string",
      "identities": [],
      "modifiedBy": "string",
      "displayName": "Justin Buchanan",
      "phoneNumber": "string",
      "emailAddress": "justin@example.com",
      "organization": {
        "type": null
      },
      "isMfaDisabled": false,
      "subscriptions": [],
      "email-verified": false,
      "organizationId": 0,
      "mfaEnrollmentStatus": "string",
      "authenticationMethod": "string",
      "recoveryEmailAddress": "string",
      "applicationDeployments": [],
      "email-verify-sent-date": "string",
      "email-verification-status-type": "string"
    },
    "roles": [
      {
        "id": "string",
        "name": "string",
        "expires": "string",
        "description": "string"
      }
    ],
    "created": "string",
    "ownerId": "string",
    "picture": "string",
    "isActive": false,
    "language": "string",
    "memberOf": [
      {
        "id": "string",
        "user": null,
        "roles": [],
        "userId": "string",
        "created": "string",
        "isGuest": false,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "isMfaRequired": false,
        "organizationId": 0,
        "organizationName": "string",
        "isMembershipMfaRequired": false,
        "organizationDisplayName": "string"
      }
    ],
    "modified": "string",
    "nickname": "string",
    "username": "string",
    "createdBy": "string",
    "givenName": "string",
    "attributes": [
      {
        "id": 0,
        "name": "string",
        "value": "string",
        "userId": "string",
        "expires": "string"
      }
    ],
    "customUpns": [
      {
        "id": "string",
        "userId": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "clientUpnKey": "string",
        "customUpnValue": "string"
      }
    ],
    "familyName": "string",
    "identities": [
      {
        "id": 0,
        "groups": [],
        "strategy": "string",
        "azoUserId": "string",
        "idpTenantId": 0,
        "loginDomain": "string",
        "azoTenantName": "string",
        "idpTenantFqdn": "string",
        "idpTenantName": "string",
        "azoConnectionId": "string"
      }
    ],
    "modifiedBy": "string",
    "displayName": "Justin Buchanan",
    "phoneNumber": "string",
    "emailAddress": "justin@example.com",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "aliases": [],
      "contact": "string",
      "created": "string",
      "domains": [],
      "members": [],
      "isActive": false,
      "modified": "string",
      "products": [],
      "createdBy": "string",
      "modifiedBy": "string",
      "allowUpsell": false,
      "displayName": "string",
      "applications": [],
      "crmAccountId": "string",
      "isMfaRequired": false,
      "isSelfService": false,
      "subscriptions": [],
      "technicalContact": "string",
      "isEnabledForPreviewFeatures": false,
      "isDomainVerificationRequired": false
    },
    "isMfaDisabled": false,
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      }
    ],
    "email-verified": false,
    "organizationId": 0,
    "mfaEnrollmentStatus": "string",
    "authenticationMethod": "string",
    "recoveryEmailAddress": "string",
    "applicationDeployments": [
      {
        "id": 0,
        "name": "string",
        "steps": [],
        "status": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "application": null,
        "displayName": "string",
        "maxUserCount": 0,
        "subscription": null,
        "applicationId": 0,
        "configuration": "string",
        "customMetadata": null,
        "subscriptionId": 0,
        "deploymentTarget": null,
        "readonlyMetadata": null,
        "statusResolution": "string",
        "deploymentTargetId": 0
      }
    ],
    "email-verify-sent-date": "string",
    "email-verification-status-type": "string"
  },
  "roles": [
    {
      "id": "string",
      "name": "string",
      "expires": "string",
      "description": "string"
    }
  ],
  "created": "string",
  "ownerId": "string",
  "picture": "string",
  "isActive": false,
  "language": "string",
  "memberOf": [
    {
      "id": "string",
      "user": {
        "id": "string",
        "type": null,
        "owner": null,
        "roles": [],
        "created": "string",
        "ownerId": "string",
        "picture": "string",
        "isActive": false,
        "language": "string",
        "memberOf": [],
        "modified": "string",
        "nickname": "string",
        "username": "string",
        "createdBy": "string",
        "givenName": "string",
        "attributes": [],
        "customUpns": [],
        "familyName": "string",
        "identities": [],
        "modifiedBy": "string",
        "displayName": "Justin Buchanan",
        "phoneNumber": "string",
        "emailAddress": "justin@example.com",
        "organization": null,
        "isMfaDisabled": false,
        "subscriptions": [],
        "email-verified": false,
        "organizationId": 0,
        "mfaEnrollmentStatus": "string",
        "authenticationMethod": null,
        "recoveryEmailAddress": "string",
        "applicationDeployments": [],
        "email-verify-sent-date": "string",
        "email-verification-status-type": null
      },
      "roles": [
        {}
      ],
      "userId": "string",
      "created": "string",
      "isGuest": false,
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "isMfaRequired": false,
      "organizationId": 0,
      "organizationName": "string",
      "isMembershipMfaRequired": false,
      "organizationDisplayName": "string"
    }
  ],
  "modified": "string",
  "nickname": "string",
  "username": "string",
  "createdBy": "string",
  "givenName": "string",
  "attributes": [
    {
      "id": 0,
      "name": "string",
      "value": "string",
      "userId": "string",
      "expires": "string"
    }
  ],
  "customUpns": [
    {
      "id": "string",
      "userId": "string",
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "clientUpnKey": "string",
      "customUpnValue": "string"
    }
  ],
  "familyName": "string",
  "identities": [
    {
      "id": 0,
      "groups": [
        {}
      ],
      "strategy": "string",
      "azoUserId": "string",
      "idpTenantId": 0,
      "loginDomain": "string",
      "azoTenantName": "string",
      "idpTenantFqdn": "string",
      "idpTenantName": "string",
      "azoConnectionId": "string"
    }
  ],
  "modifiedBy": "string",
  "displayName": "Justin Buchanan",
  "phoneNumber": "string",
  "emailAddress": "justin@example.com",
  "organization": {
    "id": 0,
    "name": "string",
    "type": "string",
    "aliases": [
      {
        "created": "string",
        "systemId": "string",
        "systemName": "string",
        "organizationId": 0
      }
    ],
    "contact": "string",
    "created": "string",
    "domains": [
      {
        "domain": "string",
        "created": "string",
        "domainId": 0,
        "modified": "string",
        "createdBy": "string",
        "isVerified": false,
        "modifiedBy": "string",
        "organizationId": 0,
        "verificationCode": "string",
        "verificationMethod": "string",
        "ownerOrganizationId": 0,
        "authenticationMethod": "string",
        "verificationCodeExpires": "string"
      }
    ],
    "members": [
      {
        "id": "string",
        "user": null,
        "roles": [],
        "userId": "string",
        "created": "string",
        "isGuest": false,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "isMfaRequired": false,
        "organizationId": 0,
        "organizationName": "string",
        "isMembershipMfaRequired": false,
        "organizationDisplayName": "string"
      }
    ],
    "isActive": false,
    "modified": "string",
    "products": [
      {
        "id": 0,
        "url": "string",
        "name": "string",
        "created": "string",
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "displayName": "string",
        "applications": [],
        "organization": null,
        "subscriptions": [],
        "organizationId": 0,
        "publicMetadata": null,
        "longDescription": "string"
      }
    ],
    "createdBy": "string",
    "modifiedBy": "string",
    "allowUpsell": false,
    "displayName": "string",
    "applications": [
      {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      }
    ],
    "crmAccountId": "string",
    "isMfaRequired": false,
    "isSelfService": false,
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      }
    ],
    "technicalContact": "string",
    "isEnabledForPreviewFeatures": false,
    "isDomainVerificationRequired": false
  },
  "isMfaDisabled": false,
  "subscriptions": [
    {
      "id": 0,
      "logs": [
        {
          "severity": null,
          "subscription": null
        }
      ],
      "type": "string",
      "status": "string",
      "created": "string",
      "details": "string",
      "expires": "string",
      "product": {
        "id": 0,
        "url": "string",
        "name": "string",
        "created": "string",
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "displayName": "string",
        "applications": [],
        "organization": null,
        "subscriptions": [],
        "organizationId": 0,
        "publicMetadata": null,
        "longDescription": "string"
      },
      "modified": "string",
      "createdBy": "string",
      "isEnabled": false,
      "productId": 0,
      "modifiedBy": "string",
      "statusText": "string",
      "description": "string",
      "organization": {
        "id": 0,
        "name": "string",
        "type": null,
        "aliases": [],
        "contact": "string",
        "created": "string",
        "domains": [],
        "members": [],
        "isActive": false,
        "modified": "string",
        "products": [],
        "createdBy": "string",
        "modifiedBy": "string",
        "allowUpsell": false,
        "displayName": "string",
        "applications": [],
        "crmAccountId": "string",
        "isMfaRequired": false,
        "isSelfService": false,
        "subscriptions": [],
        "technicalContact": "string",
        "isEnabledForPreviewFeatures": false,
        "isDomainVerificationRequired": false
      },
      "customMetadata": {},
      "organizationId": 0,
      "readonlyMetadata": {},
      "applicationDeployments": [
        {
          "application": null,
          "subscription": null,
          "customMetadata": null,
          "deploymentTarget": null,
          "readonlyMetadata": null
        }
      ]
    }
  ],
  "email-verified": false,
  "organizationId": 0,
  "mfaEnrollmentStatus": "string",
  "authenticationMethod": "string",
  "recoveryEmailAddress": "string",
  "applicationDeployments": [
    {
      "id": 0,
      "name": "string",
      "steps": [
        {}
      ],
      "status": "string",
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "application": {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      },
      "displayName": "string",
      "maxUserCount": 0,
      "subscription": {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      },
      "applicationId": 0,
      "configuration": "string",
      "customMetadata": {},
      "subscriptionId": 0,
      "deploymentTarget": {
        "id": 0,
        "name": "string",
        "country": "string",
        "created": "string",
        "details": null,
        "isActive": false,
        "modified": "string",
        "createdBy": "string",
        "publicUrl": "string",
        "modifiedBy": "string",
        "application": null,
        "description": "string",
        "displayName": "string",
        "environment": "string",
        "applicationId": 0
      },
      "readonlyMetadata": {},
      "statusResolution": "string",
      "deploymentTargetId": 0
    }
  ],
  "email-verify-sent-date": "string",
  "email-verification-status-type": "string"
}
Schema
Name Type Attributes Description Extensions
displayName string required A display name to use when showing the user information to admins and other users.
minLength: 1 · maxLength: 250
 —
emailAddress string required The user's email address. This value will be used as the primary method of identifying a user on sign-in. <list type="bullet"><item> This value must be globally unique. </item><item> This value must adhere to the format 'user@domain' </item><item> The email address is not validated (by default). </item></list>
minLength: 1 · maxLength: 250
 —
applicationDeployments nullable — —
attributes nullable — —
authenticationMethod AuthenticationMethod — A list of methods by which a user can authenticate.
Value Description
Database —
Ad —
Federation —
Email —
Sms —
—
created string (date-time) nullable The date the user was created (in UTC). —
createdBy string nullable The identifier of the principal that created the user. —
customUpns nullable — —
email-verification-status-type EmailStatusType — —
Value Description
Unsent —
Pending —
Accepted —
Expired —
—
email-verified boolean — — —
email-verify-sent-date string (date-time) nullable — —
familyName string nullable The users family or last name.
maxLength: 200
 —
givenName string nullable The users given or first name.
maxLength: 200
 —
id string nullable The system assigned unique identifier. —
identities nullable The collection of tenants where this user exists. Only applies to federated or social users. —
isActive boolean nullable Indicates if the user's account is active. —
isMfaDisabled boolean nullable Indicates if the user is required to use multi-factor authentication. This is only applicable if Nexus.Backend.Domain.User.UserModel.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. —
language string nullable The user who owns the device. —
memberOf nullable The list of organizations the user is a member of —
mfaEnrollmentStatus string nullable The user who owns the device. —
modified string (date-time) nullable The date the user was last modified (in UTC). —
modifiedBy string nullable The identifier of the principal that last modified the user. —
nickname string nullable A nickname for the user.
maxLength: 200
 —
organization — Represents an Organization —
organizationId integer (int32) nullable The organization to which the user belongs. —
owner — — —
ownerId string nullable The user who owns the device. —
phoneNumber string nullable A phone number for the user. This number may be used for SMS based MFA.
maxLength: 50
 —
picture string nullable A URL to a picture of the user.
maxLength: 250
 —
recoveryEmailAddress string nullable The user's email address for account recovery purposes. This value is not required. If not provided, the Nexus.Backend.Domain.User.UserModel.EmailAddress will be used. —
roles nullable List of user roles —
subscriptions nullable — —
type UserType — Defines a list of valid principal types.
Value Description
Person —
Device —
—
username string nullable A nickname for the user.
maxLength: 200
 —
Example 
{
  "id": "string",
  "type": "string",
  "owner": {
    "id": "string",
    "type": "string",
    "owner": {
      "id": "string",
      "type": "string",
      "owner": {
        "type": null,
        "owner": null,
        "organization": null,
        "authenticationMethod": null,
        "email-verification-status-type": null
      },
      "roles": [],
      "created": "string",
      "ownerId": "string",
      "picture": "string",
      "isActive": false,
      "language": "string",
      "memberOf": [],
      "modified": "string",
      "nickname": "string",
      "username": "string",
      "createdBy": "string",
      "givenName": "string",
      "attributes": [],
      "customUpns": [],
      "familyName": "string",
      "identities": [],
      "modifiedBy": "string",
      "displayName": "Justin Buchanan",
      "phoneNumber": "string",
      "emailAddress": "justin@example.com",
      "organization": {
        "type": null
      },
      "isMfaDisabled": false,
      "subscriptions": [],
      "email-verified": false,
      "organizationId": 0,
      "mfaEnrollmentStatus": "string",
      "authenticationMethod": "string",
      "recoveryEmailAddress": "string",
      "applicationDeployments": [],
      "email-verify-sent-date": "string",
      "email-verification-status-type": "string"
    },
    "roles": [
      {
        "id": "string",
        "name": "string",
        "expires": "string",
        "description": "string"
      }
    ],
    "created": "string",
    "ownerId": "string",
    "picture": "string",
    "isActive": false,
    "language": "string",
    "memberOf": [
      {
        "id": "string",
        "user": null,
        "roles": [],
        "userId": "string",
        "created": "string",
        "isGuest": false,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "isMfaRequired": false,
        "organizationId": 0,
        "organizationName": "string",
        "isMembershipMfaRequired": false,
        "organizationDisplayName": "string"
      }
    ],
    "modified": "string",
    "nickname": "string",
    "username": "string",
    "createdBy": "string",
    "givenName": "string",
    "attributes": [
      {
        "id": 0,
        "name": "string",
        "value": "string",
        "userId": "string",
        "expires": "string"
      }
    ],
    "customUpns": [
      {
        "id": "string",
        "userId": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "clientUpnKey": "string",
        "customUpnValue": "string"
      }
    ],
    "familyName": "string",
    "identities": [
      {
        "id": 0,
        "groups": [],
        "strategy": "string",
        "azoUserId": "string",
        "idpTenantId": 0,
        "loginDomain": "string",
        "azoTenantName": "string",
        "idpTenantFqdn": "string",
        "idpTenantName": "string",
        "azoConnectionId": "string"
      }
    ],
    "modifiedBy": "string",
    "displayName": "Justin Buchanan",
    "phoneNumber": "string",
    "emailAddress": "justin@example.com",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "aliases": [],
      "contact": "string",
      "created": "string",
      "domains": [],
      "members": [],
      "isActive": false,
      "modified": "string",
      "products": [],
      "createdBy": "string",
      "modifiedBy": "string",
      "allowUpsell": false,
      "displayName": "string",
      "applications": [],
      "crmAccountId": "string",
      "isMfaRequired": false,
      "isSelfService": false,
      "subscriptions": [],
      "technicalContact": "string",
      "isEnabledForPreviewFeatures": false,
      "isDomainVerificationRequired": false
    },
    "isMfaDisabled": false,
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      }
    ],
    "email-verified": false,
    "organizationId": 0,
    "mfaEnrollmentStatus": "string",
    "authenticationMethod": "string",
    "recoveryEmailAddress": "string",
    "applicationDeployments": [
      {
        "id": 0,
        "name": "string",
        "steps": [],
        "status": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "application": null,
        "displayName": "string",
        "maxUserCount": 0,
        "subscription": null,
        "applicationId": 0,
        "configuration": "string",
        "customMetadata": null,
        "subscriptionId": 0,
        "deploymentTarget": null,
        "readonlyMetadata": null,
        "statusResolution": "string",
        "deploymentTargetId": 0
      }
    ],
    "email-verify-sent-date": "string",
    "email-verification-status-type": "string"
  },
  "roles": [
    {
      "id": "string",
      "name": "string",
      "expires": "string",
      "description": "string"
    }
  ],
  "created": "string",
  "ownerId": "string",
  "picture": "string",
  "isActive": false,
  "language": "string",
  "memberOf": [
    {
      "id": "string",
      "user": {
        "id": "string",
        "type": null,
        "owner": null,
        "roles": [],
        "created": "string",
        "ownerId": "string",
        "picture": "string",
        "isActive": false,
        "language": "string",
        "memberOf": [],
        "modified": "string",
        "nickname": "string",
        "username": "string",
        "createdBy": "string",
        "givenName": "string",
        "attributes": [],
        "customUpns": [],
        "familyName": "string",
        "identities": [],
        "modifiedBy": "string",
        "displayName": "Justin Buchanan",
        "phoneNumber": "string",
        "emailAddress": "justin@example.com",
        "organization": null,
        "isMfaDisabled": false,
        "subscriptions": [],
        "email-verified": false,
        "organizationId": 0,
        "mfaEnrollmentStatus": "string",
        "authenticationMethod": null,
        "recoveryEmailAddress": "string",
        "applicationDeployments": [],
        "email-verify-sent-date": "string",
        "email-verification-status-type": null
      },
      "roles": [
        {}
      ],
      "userId": "string",
      "created": "string",
      "isGuest": false,
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "isMfaRequired": false,
      "organizationId": 0,
      "organizationName": "string",
      "isMembershipMfaRequired": false,
      "organizationDisplayName": "string"
    }
  ],
  "modified": "string",
  "nickname": "string",
  "username": "string",
  "createdBy": "string",
  "givenName": "string",
  "attributes": [
    {
      "id": 0,
      "name": "string",
      "value": "string",
      "userId": "string",
      "expires": "string"
    }
  ],
  "customUpns": [
    {
      "id": "string",
      "userId": "string",
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "clientUpnKey": "string",
      "customUpnValue": "string"
    }
  ],
  "familyName": "string",
  "identities": [
    {
      "id": 0,
      "groups": [
        {}
      ],
      "strategy": "string",
      "azoUserId": "string",
      "idpTenantId": 0,
      "loginDomain": "string",
      "azoTenantName": "string",
      "idpTenantFqdn": "string",
      "idpTenantName": "string",
      "azoConnectionId": "string"
    }
  ],
  "modifiedBy": "string",
  "displayName": "Justin Buchanan",
  "phoneNumber": "string",
  "emailAddress": "justin@example.com",
  "organization": {
    "id": 0,
    "name": "string",
    "type": "string",
    "aliases": [
      {
        "created": "string",
        "systemId": "string",
        "systemName": "string",
        "organizationId": 0
      }
    ],
    "contact": "string",
    "created": "string",
    "domains": [
      {
        "domain": "string",
        "created": "string",
        "domainId": 0,
        "modified": "string",
        "createdBy": "string",
        "isVerified": false,
        "modifiedBy": "string",
        "organizationId": 0,
        "verificationCode": "string",
        "verificationMethod": "string",
        "ownerOrganizationId": 0,
        "authenticationMethod": "string",
        "verificationCodeExpires": "string"
      }
    ],
    "members": [
      {
        "id": "string",
        "user": null,
        "roles": [],
        "userId": "string",
        "created": "string",
        "isGuest": false,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "isMfaRequired": false,
        "organizationId": 0,
        "organizationName": "string",
        "isMembershipMfaRequired": false,
        "organizationDisplayName": "string"
      }
    ],
    "isActive": false,
    "modified": "string",
    "products": [
      {
        "id": 0,
        "url": "string",
        "name": "string",
        "created": "string",
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "displayName": "string",
        "applications": [],
        "organization": null,
        "subscriptions": [],
        "organizationId": 0,
        "publicMetadata": null,
        "longDescription": "string"
      }
    ],
    "createdBy": "string",
    "modifiedBy": "string",
    "allowUpsell": false,
    "displayName": "string",
    "applications": [
      {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      }
    ],
    "crmAccountId": "string",
    "isMfaRequired": false,
    "isSelfService": false,
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      }
    ],
    "technicalContact": "string",
    "isEnabledForPreviewFeatures": false,
    "isDomainVerificationRequired": false
  },
  "isMfaDisabled": false,
  "subscriptions": [
    {
      "id": 0,
      "logs": [
        {
          "severity": null,
          "subscription": null
        }
      ],
      "type": "string",
      "status": "string",
      "created": "string",
      "details": "string",
      "expires": "string",
      "product": {
        "id": 0,
        "url": "string",
        "name": "string",
        "created": "string",
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "displayName": "string",
        "applications": [],
        "organization": null,
        "subscriptions": [],
        "organizationId": 0,
        "publicMetadata": null,
        "longDescription": "string"
      },
      "modified": "string",
      "createdBy": "string",
      "isEnabled": false,
      "productId": 0,
      "modifiedBy": "string",
      "statusText": "string",
      "description": "string",
      "organization": {
        "id": 0,
        "name": "string",
        "type": null,
        "aliases": [],
        "contact": "string",
        "created": "string",
        "domains": [],
        "members": [],
        "isActive": false,
        "modified": "string",
        "products": [],
        "createdBy": "string",
        "modifiedBy": "string",
        "allowUpsell": false,
        "displayName": "string",
        "applications": [],
        "crmAccountId": "string",
        "isMfaRequired": false,
        "isSelfService": false,
        "subscriptions": [],
        "technicalContact": "string",
        "isEnabledForPreviewFeatures": false,
        "isDomainVerificationRequired": false
      },
      "customMetadata": {},
      "organizationId": 0,
      "readonlyMetadata": {},
      "applicationDeployments": [
        {
          "application": null,
          "subscription": null,
          "customMetadata": null,
          "deploymentTarget": null,
          "readonlyMetadata": null
        }
      ]
    }
  ],
  "email-verified": false,
  "organizationId": 0,
  "mfaEnrollmentStatus": "string",
  "authenticationMethod": "string",
  "recoveryEmailAddress": "string",
  "applicationDeployments": [
    {
      "id": 0,
      "name": "string",
      "steps": [
        {}
      ],
      "status": "string",
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "application": {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      },
      "displayName": "string",
      "maxUserCount": 0,
      "subscription": {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      },
      "applicationId": 0,
      "configuration": "string",
      "customMetadata": {},
      "subscriptionId": 0,
      "deploymentTarget": {
        "id": 0,
        "name": "string",
        "country": "string",
        "created": "string",
        "details": null,
        "isActive": false,
        "modified": "string",
        "createdBy": "string",
        "publicUrl": "string",
        "modifiedBy": "string",
        "application": null,
        "description": "string",
        "displayName": "string",
        "environment": "string",
        "applicationId": 0
      },
      "readonlyMetadata": {},
      "statusResolution": "string",
      "deploymentTargetId": 0
    }
  ],
  "email-verify-sent-date": "string",
  "email-verification-status-type": "string"
}
Schema
Name Type Attributes Description Extensions
displayName string required A display name to use when showing the user information to admins and other users.
minLength: 1 · maxLength: 250
 —
emailAddress string required The user's email address. This value will be used as the primary method of identifying a user on sign-in. <list type="bullet"><item> This value must be globally unique. </item><item> This value must adhere to the format 'user@domain' </item><item> The email address is not validated (by default). </item></list>
minLength: 1 · maxLength: 250
 —
applicationDeployments nullable — —
attributes nullable — —
authenticationMethod AuthenticationMethod — A list of methods by which a user can authenticate.
Value Description
Database —
Ad —
Federation —
Email —
Sms —
—
created string (date-time) nullable The date the user was created (in UTC). —
createdBy string nullable The identifier of the principal that created the user. —
customUpns nullable — —
email-verification-status-type EmailStatusType — —
Value Description
Unsent —
Pending —
Accepted —
Expired —
—
email-verified boolean — — —
email-verify-sent-date string (date-time) nullable — —
familyName string nullable The users family or last name.
maxLength: 200
 —
givenName string nullable The users given or first name.
maxLength: 200
 —
id string nullable The system assigned unique identifier. —
identities nullable The collection of tenants where this user exists. Only applies to federated or social users. —
isActive boolean nullable Indicates if the user's account is active. —
isMfaDisabled boolean nullable Indicates if the user is required to use multi-factor authentication. This is only applicable if Nexus.Backend.Domain.User.UserModel.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. —
language string nullable The user who owns the device. —
memberOf nullable The list of organizations the user is a member of —
mfaEnrollmentStatus string nullable The user who owns the device. —
modified string (date-time) nullable The date the user was last modified (in UTC). —
modifiedBy string nullable The identifier of the principal that last modified the user. —
nickname string nullable A nickname for the user.
maxLength: 200
 —
organization — Represents an Organization —
organizationId integer (int32) nullable The organization to which the user belongs. —
owner — — —
ownerId string nullable The user who owns the device. —
phoneNumber string nullable A phone number for the user. This number may be used for SMS based MFA.
maxLength: 50
 —
picture string nullable A URL to a picture of the user.
maxLength: 250
 —
recoveryEmailAddress string nullable The user's email address for account recovery purposes. This value is not required. If not provided, the Nexus.Backend.Domain.User.UserModel.EmailAddress will be used. —
roles nullable List of user roles —
subscriptions nullable — —
type UserType — Defines a list of valid principal types.
Value Description
Person —
Device —
—
username string nullable A nickname for the user.
maxLength: 200
 —
Example 
{
  "id": "string",
  "type": "string",
  "owner": {
    "id": "string",
    "type": "string",
    "owner": {
      "id": "string",
      "type": "string",
      "owner": {
        "type": null,
        "owner": null,
        "organization": null,
        "authenticationMethod": null,
        "email-verification-status-type": null
      },
      "roles": [],
      "created": "string",
      "ownerId": "string",
      "picture": "string",
      "isActive": false,
      "language": "string",
      "memberOf": [],
      "modified": "string",
      "nickname": "string",
      "username": "string",
      "createdBy": "string",
      "givenName": "string",
      "attributes": [],
      "customUpns": [],
      "familyName": "string",
      "identities": [],
      "modifiedBy": "string",
      "displayName": "Justin Buchanan",
      "phoneNumber": "string",
      "emailAddress": "justin@example.com",
      "organization": {
        "type": null
      },
      "isMfaDisabled": false,
      "subscriptions": [],
      "email-verified": false,
      "organizationId": 0,
      "mfaEnrollmentStatus": "string",
      "authenticationMethod": "string",
      "recoveryEmailAddress": "string",
      "applicationDeployments": [],
      "email-verify-sent-date": "string",
      "email-verification-status-type": "string"
    },
    "roles": [
      {
        "id": "string",
        "name": "string",
        "expires": "string",
        "description": "string"
      }
    ],
    "created": "string",
    "ownerId": "string",
    "picture": "string",
    "isActive": false,
    "language": "string",
    "memberOf": [
      {
        "id": "string",
        "user": null,
        "roles": [],
        "userId": "string",
        "created": "string",
        "isGuest": false,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "isMfaRequired": false,
        "organizationId": 0,
        "organizationName": "string",
        "isMembershipMfaRequired": false,
        "organizationDisplayName": "string"
      }
    ],
    "modified": "string",
    "nickname": "string",
    "username": "string",
    "createdBy": "string",
    "givenName": "string",
    "attributes": [
      {
        "id": 0,
        "name": "string",
        "value": "string",
        "userId": "string",
        "expires": "string"
      }
    ],
    "customUpns": [
      {
        "id": "string",
        "userId": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "clientUpnKey": "string",
        "customUpnValue": "string"
      }
    ],
    "familyName": "string",
    "identities": [
      {
        "id": 0,
        "groups": [],
        "strategy": "string",
        "azoUserId": "string",
        "idpTenantId": 0,
        "loginDomain": "string",
        "azoTenantName": "string",
        "idpTenantFqdn": "string",
        "idpTenantName": "string",
        "azoConnectionId": "string"
      }
    ],
    "modifiedBy": "string",
    "displayName": "Justin Buchanan",
    "phoneNumber": "string",
    "emailAddress": "justin@example.com",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "aliases": [],
      "contact": "string",
      "created": "string",
      "domains": [],
      "members": [],
      "isActive": false,
      "modified": "string",
      "products": [],
      "createdBy": "string",
      "modifiedBy": "string",
      "allowUpsell": false,
      "displayName": "string",
      "applications": [],
      "crmAccountId": "string",
      "isMfaRequired": false,
      "isSelfService": false,
      "subscriptions": [],
      "technicalContact": "string",
      "isEnabledForPreviewFeatures": false,
      "isDomainVerificationRequired": false
    },
    "isMfaDisabled": false,
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      }
    ],
    "email-verified": false,
    "organizationId": 0,
    "mfaEnrollmentStatus": "string",
    "authenticationMethod": "string",
    "recoveryEmailAddress": "string",
    "applicationDeployments": [
      {
        "id": 0,
        "name": "string",
        "steps": [],
        "status": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "application": null,
        "displayName": "string",
        "maxUserCount": 0,
        "subscription": null,
        "applicationId": 0,
        "configuration": "string",
        "customMetadata": null,
        "subscriptionId": 0,
        "deploymentTarget": null,
        "readonlyMetadata": null,
        "statusResolution": "string",
        "deploymentTargetId": 0
      }
    ],
    "email-verify-sent-date": "string",
    "email-verification-status-type": "string"
  },
  "roles": [
    {
      "id": "string",
      "name": "string",
      "expires": "string",
      "description": "string"
    }
  ],
  "created": "string",
  "ownerId": "string",
  "picture": "string",
  "isActive": false,
  "language": "string",
  "memberOf": [
    {
      "id": "string",
      "user": {
        "id": "string",
        "type": null,
        "owner": null,
        "roles": [],
        "created": "string",
        "ownerId": "string",
        "picture": "string",
        "isActive": false,
        "language": "string",
        "memberOf": [],
        "modified": "string",
        "nickname": "string",
        "username": "string",
        "createdBy": "string",
        "givenName": "string",
        "attributes": [],
        "customUpns": [],
        "familyName": "string",
        "identities": [],
        "modifiedBy": "string",
        "displayName": "Justin Buchanan",
        "phoneNumber": "string",
        "emailAddress": "justin@example.com",
        "organization": null,
        "isMfaDisabled": false,
        "subscriptions": [],
        "email-verified": false,
        "organizationId": 0,
        "mfaEnrollmentStatus": "string",
        "authenticationMethod": null,
        "recoveryEmailAddress": "string",
        "applicationDeployments": [],
        "email-verify-sent-date": "string",
        "email-verification-status-type": null
      },
      "roles": [
        {}
      ],
      "userId": "string",
      "created": "string",
      "isGuest": false,
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "isMfaRequired": false,
      "organizationId": 0,
      "organizationName": "string",
      "isMembershipMfaRequired": false,
      "organizationDisplayName": "string"
    }
  ],
  "modified": "string",
  "nickname": "string",
  "username": "string",
  "createdBy": "string",
  "givenName": "string",
  "attributes": [
    {
      "id": 0,
      "name": "string",
      "value": "string",
      "userId": "string",
      "expires": "string"
    }
  ],
  "customUpns": [
    {
      "id": "string",
      "userId": "string",
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "clientUpnKey": "string",
      "customUpnValue": "string"
    }
  ],
  "familyName": "string",
  "identities": [
    {
      "id": 0,
      "groups": [
        {}
      ],
      "strategy": "string",
      "azoUserId": "string",
      "idpTenantId": 0,
      "loginDomain": "string",
      "azoTenantName": "string",
      "idpTenantFqdn": "string",
      "idpTenantName": "string",
      "azoConnectionId": "string"
    }
  ],
  "modifiedBy": "string",
  "displayName": "Justin Buchanan",
  "phoneNumber": "string",
  "emailAddress": "justin@example.com",
  "organization": {
    "id": 0,
    "name": "string",
    "type": "string",
    "aliases": [
      {
        "created": "string",
        "systemId": "string",
        "systemName": "string",
        "organizationId": 0
      }
    ],
    "contact": "string",
    "created": "string",
    "domains": [
      {
        "domain": "string",
        "created": "string",
        "domainId": 0,
        "modified": "string",
        "createdBy": "string",
        "isVerified": false,
        "modifiedBy": "string",
        "organizationId": 0,
        "verificationCode": "string",
        "verificationMethod": "string",
        "ownerOrganizationId": 0,
        "authenticationMethod": "string",
        "verificationCodeExpires": "string"
      }
    ],
    "members": [
      {
        "id": "string",
        "user": null,
        "roles": [],
        "userId": "string",
        "created": "string",
        "isGuest": false,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "isMfaRequired": false,
        "organizationId": 0,
        "organizationName": "string",
        "isMembershipMfaRequired": false,
        "organizationDisplayName": "string"
      }
    ],
    "isActive": false,
    "modified": "string",
    "products": [
      {
        "id": 0,
        "url": "string",
        "name": "string",
        "created": "string",
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "displayName": "string",
        "applications": [],
        "organization": null,
        "subscriptions": [],
        "organizationId": 0,
        "publicMetadata": null,
        "longDescription": "string"
      }
    ],
    "createdBy": "string",
    "modifiedBy": "string",
    "allowUpsell": false,
    "displayName": "string",
    "applications": [
      {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      }
    ],
    "crmAccountId": "string",
    "isMfaRequired": false,
    "isSelfService": false,
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      }
    ],
    "technicalContact": "string",
    "isEnabledForPreviewFeatures": false,
    "isDomainVerificationRequired": false
  },
  "isMfaDisabled": false,
  "subscriptions": [
    {
      "id": 0,
      "logs": [
        {
          "severity": null,
          "subscription": null
        }
      ],
      "type": "string",
      "status": "string",
      "created": "string",
      "details": "string",
      "expires": "string",
      "product": {
        "id": 0,
        "url": "string",
        "name": "string",
        "created": "string",
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "displayName": "string",
        "applications": [],
        "organization": null,
        "subscriptions": [],
        "organizationId": 0,
        "publicMetadata": null,
        "longDescription": "string"
      },
      "modified": "string",
      "createdBy": "string",
      "isEnabled": false,
      "productId": 0,
      "modifiedBy": "string",
      "statusText": "string",
      "description": "string",
      "organization": {
        "id": 0,
        "name": "string",
        "type": null,
        "aliases": [],
        "contact": "string",
        "created": "string",
        "domains": [],
        "members": [],
        "isActive": false,
        "modified": "string",
        "products": [],
        "createdBy": "string",
        "modifiedBy": "string",
        "allowUpsell": false,
        "displayName": "string",
        "applications": [],
        "crmAccountId": "string",
        "isMfaRequired": false,
        "isSelfService": false,
        "subscriptions": [],
        "technicalContact": "string",
        "isEnabledForPreviewFeatures": false,
        "isDomainVerificationRequired": false
      },
      "customMetadata": {},
      "organizationId": 0,
      "readonlyMetadata": {},
      "applicationDeployments": [
        {
          "application": null,
          "subscription": null,
          "customMetadata": null,
          "deploymentTarget": null,
          "readonlyMetadata": null
        }
      ]
    }
  ],
  "email-verified": false,
  "organizationId": 0,
  "mfaEnrollmentStatus": "string",
  "authenticationMethod": "string",
  "recoveryEmailAddress": "string",
  "applicationDeployments": [
    {
      "id": 0,
      "name": "string",
      "steps": [
        {}
      ],
      "status": "string",
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "application": {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      },
      "displayName": "string",
      "maxUserCount": 0,
      "subscription": {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      },
      "applicationId": 0,
      "configuration": "string",
      "customMetadata": {},
      "subscriptionId": 0,
      "deploymentTarget": {
        "id": 0,
        "name": "string",
        "country": "string",
        "created": "string",
        "details": null,
        "isActive": false,
        "modified": "string",
        "createdBy": "string",
        "publicUrl": "string",
        "modifiedBy": "string",
        "application": null,
        "description": "string",
        "displayName": "string",
        "environment": "string",
        "applicationId": 0
      },
      "readonlyMetadata": {},
      "statusResolution": "string",
      "deploymentTargetId": 0
    }
  ],
  "email-verify-sent-date": "string",
  "email-verification-status-type": "string"
}
Schema
Name Type Attributes Description Extensions
displayName string required A display name to use when showing the user information to admins and other users.
minLength: 1 · maxLength: 250
 —
emailAddress string required The user's email address. This value will be used as the primary method of identifying a user on sign-in. <list type="bullet"><item> This value must be globally unique. </item><item> This value must adhere to the format 'user@domain' </item><item> The email address is not validated (by default). </item></list>
minLength: 1 · maxLength: 250
 —
applicationDeployments nullable — —
attributes nullable — —
authenticationMethod AuthenticationMethod — A list of methods by which a user can authenticate.
Value Description
Database —
Ad —
Federation —
Email —
Sms —
—
created string (date-time) nullable The date the user was created (in UTC). —
createdBy string nullable The identifier of the principal that created the user. —
customUpns nullable — —
email-verification-status-type EmailStatusType — —
Value Description
Unsent —
Pending —
Accepted —
Expired —
—
email-verified boolean — — —
email-verify-sent-date string (date-time) nullable — —
familyName string nullable The users family or last name.
maxLength: 200
 —
givenName string nullable The users given or first name.
maxLength: 200
 —
id string nullable The system assigned unique identifier. —
identities nullable The collection of tenants where this user exists. Only applies to federated or social users. —
isActive boolean nullable Indicates if the user's account is active. —
isMfaDisabled boolean nullable Indicates if the user is required to use multi-factor authentication. This is only applicable if Nexus.Backend.Domain.User.UserModel.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. —
language string nullable The user who owns the device. —
memberOf nullable The list of organizations the user is a member of —
mfaEnrollmentStatus string nullable The user who owns the device. —
modified string (date-time) nullable The date the user was last modified (in UTC). —
modifiedBy string nullable The identifier of the principal that last modified the user. —
nickname string nullable A nickname for the user.
maxLength: 200
 —
organization — Represents an Organization —
organizationId integer (int32) nullable The organization to which the user belongs. —
owner — — —
ownerId string nullable The user who owns the device. —
phoneNumber string nullable A phone number for the user. This number may be used for SMS based MFA.
maxLength: 50
 —
picture string nullable A URL to a picture of the user.
maxLength: 250
 —
recoveryEmailAddress string nullable The user's email address for account recovery purposes. This value is not required. If not provided, the Nexus.Backend.Domain.User.UserModel.EmailAddress will be used. —
roles nullable List of user roles —
subscriptions nullable — —
type UserType — Defines a list of valid principal types.
Value Description
Person —
Device —
—
username string nullable A nickname for the user.
maxLength: 200
 —
Example 
{
  "id": "string",
  "type": "string",
  "owner": {
    "id": "string",
    "type": "string",
    "owner": {
      "id": "string",
      "type": "string",
      "owner": {
        "type": null,
        "owner": null,
        "organization": null,
        "authenticationMethod": null,
        "email-verification-status-type": null
      },
      "roles": [],
      "created": "string",
      "ownerId": "string",
      "picture": "string",
      "isActive": false,
      "language": "string",
      "memberOf": [],
      "modified": "string",
      "nickname": "string",
      "username": "string",
      "createdBy": "string",
      "givenName": "string",
      "attributes": [],
      "customUpns": [],
      "familyName": "string",
      "identities": [],
      "modifiedBy": "string",
      "displayName": "Justin Buchanan",
      "phoneNumber": "string",
      "emailAddress": "justin@example.com",
      "organization": {
        "type": null
      },
      "isMfaDisabled": false,
      "subscriptions": [],
      "email-verified": false,
      "organizationId": 0,
      "mfaEnrollmentStatus": "string",
      "authenticationMethod": "string",
      "recoveryEmailAddress": "string",
      "applicationDeployments": [],
      "email-verify-sent-date": "string",
      "email-verification-status-type": "string"
    },
    "roles": [
      {
        "id": "string",
        "name": "string",
        "expires": "string",
        "description": "string"
      }
    ],
    "created": "string",
    "ownerId": "string",
    "picture": "string",
    "isActive": false,
    "language": "string",
    "memberOf": [
      {
        "id": "string",
        "user": null,
        "roles": [],
        "userId": "string",
        "created": "string",
        "isGuest": false,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "isMfaRequired": false,
        "organizationId": 0,
        "organizationName": "string",
        "isMembershipMfaRequired": false,
        "organizationDisplayName": "string"
      }
    ],
    "modified": "string",
    "nickname": "string",
    "username": "string",
    "createdBy": "string",
    "givenName": "string",
    "attributes": [
      {
        "id": 0,
        "name": "string",
        "value": "string",
        "userId": "string",
        "expires": "string"
      }
    ],
    "customUpns": [
      {
        "id": "string",
        "userId": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "clientUpnKey": "string",
        "customUpnValue": "string"
      }
    ],
    "familyName": "string",
    "identities": [
      {
        "id": 0,
        "groups": [],
        "strategy": "string",
        "azoUserId": "string",
        "idpTenantId": 0,
        "loginDomain": "string",
        "azoTenantName": "string",
        "idpTenantFqdn": "string",
        "idpTenantName": "string",
        "azoConnectionId": "string"
      }
    ],
    "modifiedBy": "string",
    "displayName": "Justin Buchanan",
    "phoneNumber": "string",
    "emailAddress": "justin@example.com",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "aliases": [],
      "contact": "string",
      "created": "string",
      "domains": [],
      "members": [],
      "isActive": false,
      "modified": "string",
      "products": [],
      "createdBy": "string",
      "modifiedBy": "string",
      "allowUpsell": false,
      "displayName": "string",
      "applications": [],
      "crmAccountId": "string",
      "isMfaRequired": false,
      "isSelfService": false,
      "subscriptions": [],
      "technicalContact": "string",
      "isEnabledForPreviewFeatures": false,
      "isDomainVerificationRequired": false
    },
    "isMfaDisabled": false,
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      }
    ],
    "email-verified": false,
    "organizationId": 0,
    "mfaEnrollmentStatus": "string",
    "authenticationMethod": "string",
    "recoveryEmailAddress": "string",
    "applicationDeployments": [
      {
        "id": 0,
        "name": "string",
        "steps": [],
        "status": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "application": null,
        "displayName": "string",
        "maxUserCount": 0,
        "subscription": null,
        "applicationId": 0,
        "configuration": "string",
        "customMetadata": null,
        "subscriptionId": 0,
        "deploymentTarget": null,
        "readonlyMetadata": null,
        "statusResolution": "string",
        "deploymentTargetId": 0
      }
    ],
    "email-verify-sent-date": "string",
    "email-verification-status-type": "string"
  },
  "roles": [
    {
      "id": "string",
      "name": "string",
      "expires": "string",
      "description": "string"
    }
  ],
  "created": "string",
  "ownerId": "string",
  "picture": "string",
  "isActive": false,
  "language": "string",
  "memberOf": [
    {
      "id": "string",
      "user": {
        "id": "string",
        "type": null,
        "owner": null,
        "roles": [],
        "created": "string",
        "ownerId": "string",
        "picture": "string",
        "isActive": false,
        "language": "string",
        "memberOf": [],
        "modified": "string",
        "nickname": "string",
        "username": "string",
        "createdBy": "string",
        "givenName": "string",
        "attributes": [],
        "customUpns": [],
        "familyName": "string",
        "identities": [],
        "modifiedBy": "string",
        "displayName": "Justin Buchanan",
        "phoneNumber": "string",
        "emailAddress": "justin@example.com",
        "organization": null,
        "isMfaDisabled": false,
        "subscriptions": [],
        "email-verified": false,
        "organizationId": 0,
        "mfaEnrollmentStatus": "string",
        "authenticationMethod": null,
        "recoveryEmailAddress": "string",
        "applicationDeployments": [],
        "email-verify-sent-date": "string",
        "email-verification-status-type": null
      },
      "roles": [
        {}
      ],
      "userId": "string",
      "created": "string",
      "isGuest": false,
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "isMfaRequired": false,
      "organizationId": 0,
      "organizationName": "string",
      "isMembershipMfaRequired": false,
      "organizationDisplayName": "string"
    }
  ],
  "modified": "string",
  "nickname": "string",
  "username": "string",
  "createdBy": "string",
  "givenName": "string",
  "attributes": [
    {
      "id": 0,
      "name": "string",
      "value": "string",
      "userId": "string",
      "expires": "string"
    }
  ],
  "customUpns": [
    {
      "id": "string",
      "userId": "string",
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "clientUpnKey": "string",
      "customUpnValue": "string"
    }
  ],
  "familyName": "string",
  "identities": [
    {
      "id": 0,
      "groups": [
        {}
      ],
      "strategy": "string",
      "azoUserId": "string",
      "idpTenantId": 0,
      "loginDomain": "string",
      "azoTenantName": "string",
      "idpTenantFqdn": "string",
      "idpTenantName": "string",
      "azoConnectionId": "string"
    }
  ],
  "modifiedBy": "string",
  "displayName": "Justin Buchanan",
  "phoneNumber": "string",
  "emailAddress": "justin@example.com",
  "organization": {
    "id": 0,
    "name": "string",
    "type": "string",
    "aliases": [
      {
        "created": "string",
        "systemId": "string",
        "systemName": "string",
        "organizationId": 0
      }
    ],
    "contact": "string",
    "created": "string",
    "domains": [
      {
        "domain": "string",
        "created": "string",
        "domainId": 0,
        "modified": "string",
        "createdBy": "string",
        "isVerified": false,
        "modifiedBy": "string",
        "organizationId": 0,
        "verificationCode": "string",
        "verificationMethod": "string",
        "ownerOrganizationId": 0,
        "authenticationMethod": "string",
        "verificationCodeExpires": "string"
      }
    ],
    "members": [
      {
        "id": "string",
        "user": null,
        "roles": [],
        "userId": "string",
        "created": "string",
        "isGuest": false,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "isMfaRequired": false,
        "organizationId": 0,
        "organizationName": "string",
        "isMembershipMfaRequired": false,
        "organizationDisplayName": "string"
      }
    ],
    "isActive": false,
    "modified": "string",
    "products": [
      {
        "id": 0,
        "url": "string",
        "name": "string",
        "created": "string",
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "displayName": "string",
        "applications": [],
        "organization": null,
        "subscriptions": [],
        "organizationId": 0,
        "publicMetadata": null,
        "longDescription": "string"
      }
    ],
    "createdBy": "string",
    "modifiedBy": "string",
    "allowUpsell": false,
    "displayName": "string",
    "applications": [
      {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      }
    ],
    "crmAccountId": "string",
    "isMfaRequired": false,
    "isSelfService": false,
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      }
    ],
    "technicalContact": "string",
    "isEnabledForPreviewFeatures": false,
    "isDomainVerificationRequired": false
  },
  "isMfaDisabled": false,
  "subscriptions": [
    {
      "id": 0,
      "logs": [
        {
          "severity": null,
          "subscription": null
        }
      ],
      "type": "string",
      "status": "string",
      "created": "string",
      "details": "string",
      "expires": "string",
      "product": {
        "id": 0,
        "url": "string",
        "name": "string",
        "created": "string",
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "displayName": "string",
        "applications": [],
        "organization": null,
        "subscriptions": [],
        "organizationId": 0,
        "publicMetadata": null,
        "longDescription": "string"
      },
      "modified": "string",
      "createdBy": "string",
      "isEnabled": false,
      "productId": 0,
      "modifiedBy": "string",
      "statusText": "string",
      "description": "string",
      "organization": {
        "id": 0,
        "name": "string",
        "type": null,
        "aliases": [],
        "contact": "string",
        "created": "string",
        "domains": [],
        "members": [],
        "isActive": false,
        "modified": "string",
        "products": [],
        "createdBy": "string",
        "modifiedBy": "string",
        "allowUpsell": false,
        "displayName": "string",
        "applications": [],
        "crmAccountId": "string",
        "isMfaRequired": false,
        "isSelfService": false,
        "subscriptions": [],
        "technicalContact": "string",
        "isEnabledForPreviewFeatures": false,
        "isDomainVerificationRequired": false
      },
      "customMetadata": {},
      "organizationId": 0,
      "readonlyMetadata": {},
      "applicationDeployments": [
        {
          "application": null,
          "subscription": null,
          "customMetadata": null,
          "deploymentTarget": null,
          "readonlyMetadata": null
        }
      ]
    }
  ],
  "email-verified": false,
  "organizationId": 0,
  "mfaEnrollmentStatus": "string",
  "authenticationMethod": "string",
  "recoveryEmailAddress": "string",
  "applicationDeployments": [
    {
      "id": 0,
      "name": "string",
      "steps": [
        {}
      ],
      "status": "string",
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "application": {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      },
      "displayName": "string",
      "maxUserCount": 0,
      "subscription": {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      },
      "applicationId": 0,
      "configuration": "string",
      "customMetadata": {},
      "subscriptionId": 0,
      "deploymentTarget": {
        "id": 0,
        "name": "string",
        "country": "string",
        "created": "string",
        "details": null,
        "isActive": false,
        "modified": "string",
        "createdBy": "string",
        "publicUrl": "string",
        "modifiedBy": "string",
        "application": null,
        "description": "string",
        "displayName": "string",
        "environment": "string",
        "applicationId": 0
      },
      "readonlyMetadata": {},
      "statusResolution": "string",
      "deploymentTargetId": 0
    }
  ],
  "email-verify-sent-date": "string",
  "email-verification-status-type": "string"
}
Schema
Name Type Attributes Description Extensions
displayName string required A display name to use when showing the user information to admins and other users.
minLength: 1 · maxLength: 250
 —
emailAddress string required The user's email address. This value will be used as the primary method of identifying a user on sign-in. <list type="bullet"><item> This value must be globally unique. </item><item> This value must adhere to the format 'user@domain' </item><item> The email address is not validated (by default). </item></list>
minLength: 1 · maxLength: 250
 —
applicationDeployments nullable — —
attributes nullable — —
authenticationMethod AuthenticationMethod — A list of methods by which a user can authenticate.
Value Description
Database —
Ad —
Federation —
Email —
Sms —
—
created string (date-time) nullable The date the user was created (in UTC). —
createdBy string nullable The identifier of the principal that created the user. —
customUpns nullable — —
email-verification-status-type EmailStatusType — —
Value Description
Unsent —
Pending —
Accepted —
Expired —
—
email-verified boolean — — —
email-verify-sent-date string (date-time) nullable — —
familyName string nullable The users family or last name.
maxLength: 200
 —
givenName string nullable The users given or first name.
maxLength: 200
 —
id string nullable The system assigned unique identifier. —
identities nullable The collection of tenants where this user exists. Only applies to federated or social users. —
isActive boolean nullable Indicates if the user's account is active. —
isMfaDisabled boolean nullable Indicates if the user is required to use multi-factor authentication. This is only applicable if Nexus.Backend.Domain.User.UserModel.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. —
language string nullable The user who owns the device. —
memberOf nullable The list of organizations the user is a member of —
mfaEnrollmentStatus string nullable The user who owns the device. —
modified string (date-time) nullable The date the user was last modified (in UTC). —
modifiedBy string nullable The identifier of the principal that last modified the user. —
nickname string nullable A nickname for the user.
maxLength: 200
 —
organization — Represents an Organization —
organizationId integer (int32) nullable The organization to which the user belongs. —
owner — — —
ownerId string nullable The user who owns the device. —
phoneNumber string nullable A phone number for the user. This number may be used for SMS based MFA.
maxLength: 50
 —
picture string nullable A URL to a picture of the user.
maxLength: 250
 —
recoveryEmailAddress string nullable The user's email address for account recovery purposes. This value is not required. If not provided, the Nexus.Backend.Domain.User.UserModel.EmailAddress will be used. —
roles nullable List of user roles —
subscriptions nullable — —
type UserType — Defines a list of valid principal types.
Value Description
Person —
Device —
—
username string nullable A nickname for the user.
maxLength: 200
 —
Example 
{
  "id": "string",
  "type": "string",
  "owner": {
    "id": "string",
    "type": "string",
    "owner": {
      "id": "string",
      "type": "string",
      "owner": {
        "type": null,
        "owner": null,
        "organization": null,
        "authenticationMethod": null,
        "email-verification-status-type": null
      },
      "roles": [],
      "created": "string",
      "ownerId": "string",
      "picture": "string",
      "isActive": false,
      "language": "string",
      "memberOf": [],
      "modified": "string",
      "nickname": "string",
      "username": "string",
      "createdBy": "string",
      "givenName": "string",
      "attributes": [],
      "customUpns": [],
      "familyName": "string",
      "identities": [],
      "modifiedBy": "string",
      "displayName": "Justin Buchanan",
      "phoneNumber": "string",
      "emailAddress": "justin@example.com",
      "organization": {
        "type": null
      },
      "isMfaDisabled": false,
      "subscriptions": [],
      "email-verified": false,
      "organizationId": 0,
      "mfaEnrollmentStatus": "string",
      "authenticationMethod": "string",
      "recoveryEmailAddress": "string",
      "applicationDeployments": [],
      "email-verify-sent-date": "string",
      "email-verification-status-type": "string"
    },
    "roles": [
      {
        "id": "string",
        "name": "string",
        "expires": "string",
        "description": "string"
      }
    ],
    "created": "string",
    "ownerId": "string",
    "picture": "string",
    "isActive": false,
    "language": "string",
    "memberOf": [
      {
        "id": "string",
        "user": null,
        "roles": [],
        "userId": "string",
        "created": "string",
        "isGuest": false,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "isMfaRequired": false,
        "organizationId": 0,
        "organizationName": "string",
        "isMembershipMfaRequired": false,
        "organizationDisplayName": "string"
      }
    ],
    "modified": "string",
    "nickname": "string",
    "username": "string",
    "createdBy": "string",
    "givenName": "string",
    "attributes": [
      {
        "id": 0,
        "name": "string",
        "value": "string",
        "userId": "string",
        "expires": "string"
      }
    ],
    "customUpns": [
      {
        "id": "string",
        "userId": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "clientUpnKey": "string",
        "customUpnValue": "string"
      }
    ],
    "familyName": "string",
    "identities": [
      {
        "id": 0,
        "groups": [],
        "strategy": "string",
        "azoUserId": "string",
        "idpTenantId": 0,
        "loginDomain": "string",
        "azoTenantName": "string",
        "idpTenantFqdn": "string",
        "idpTenantName": "string",
        "azoConnectionId": "string"
      }
    ],
    "modifiedBy": "string",
    "displayName": "Justin Buchanan",
    "phoneNumber": "string",
    "emailAddress": "justin@example.com",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "aliases": [],
      "contact": "string",
      "created": "string",
      "domains": [],
      "members": [],
      "isActive": false,
      "modified": "string",
      "products": [],
      "createdBy": "string",
      "modifiedBy": "string",
      "allowUpsell": false,
      "displayName": "string",
      "applications": [],
      "crmAccountId": "string",
      "isMfaRequired": false,
      "isSelfService": false,
      "subscriptions": [],
      "technicalContact": "string",
      "isEnabledForPreviewFeatures": false,
      "isDomainVerificationRequired": false
    },
    "isMfaDisabled": false,
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      }
    ],
    "email-verified": false,
    "organizationId": 0,
    "mfaEnrollmentStatus": "string",
    "authenticationMethod": "string",
    "recoveryEmailAddress": "string",
    "applicationDeployments": [
      {
        "id": 0,
        "name": "string",
        "steps": [],
        "status": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "application": null,
        "displayName": "string",
        "maxUserCount": 0,
        "subscription": null,
        "applicationId": 0,
        "configuration": "string",
        "customMetadata": null,
        "subscriptionId": 0,
        "deploymentTarget": null,
        "readonlyMetadata": null,
        "statusResolution": "string",
        "deploymentTargetId": 0
      }
    ],
    "email-verify-sent-date": "string",
    "email-verification-status-type": "string"
  },
  "roles": [
    {
      "id": "string",
      "name": "string",
      "expires": "string",
      "description": "string"
    }
  ],
  "created": "string",
  "ownerId": "string",
  "picture": "string",
  "isActive": false,
  "language": "string",
  "memberOf": [
    {
      "id": "string",
      "user": {
        "id": "string",
        "type": null,
        "owner": null,
        "roles": [],
        "created": "string",
        "ownerId": "string",
        "picture": "string",
        "isActive": false,
        "language": "string",
        "memberOf": [],
        "modified": "string",
        "nickname": "string",
        "username": "string",
        "createdBy": "string",
        "givenName": "string",
        "attributes": [],
        "customUpns": [],
        "familyName": "string",
        "identities": [],
        "modifiedBy": "string",
        "displayName": "Justin Buchanan",
        "phoneNumber": "string",
        "emailAddress": "justin@example.com",
        "organization": null,
        "isMfaDisabled": false,
        "subscriptions": [],
        "email-verified": false,
        "organizationId": 0,
        "mfaEnrollmentStatus": "string",
        "authenticationMethod": null,
        "recoveryEmailAddress": "string",
        "applicationDeployments": [],
        "email-verify-sent-date": "string",
        "email-verification-status-type": null
      },
      "roles": [
        {}
      ],
      "userId": "string",
      "created": "string",
      "isGuest": false,
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "isMfaRequired": false,
      "organizationId": 0,
      "organizationName": "string",
      "isMembershipMfaRequired": false,
      "organizationDisplayName": "string"
    }
  ],
  "modified": "string",
  "nickname": "string",
  "username": "string",
  "createdBy": "string",
  "givenName": "string",
  "attributes": [
    {
      "id": 0,
      "name": "string",
      "value": "string",
      "userId": "string",
      "expires": "string"
    }
  ],
  "customUpns": [
    {
      "id": "string",
      "userId": "string",
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "clientUpnKey": "string",
      "customUpnValue": "string"
    }
  ],
  "familyName": "string",
  "identities": [
    {
      "id": 0,
      "groups": [
        {}
      ],
      "strategy": "string",
      "azoUserId": "string",
      "idpTenantId": 0,
      "loginDomain": "string",
      "azoTenantName": "string",
      "idpTenantFqdn": "string",
      "idpTenantName": "string",
      "azoConnectionId": "string"
    }
  ],
  "modifiedBy": "string",
  "displayName": "Justin Buchanan",
  "phoneNumber": "string",
  "emailAddress": "justin@example.com",
  "organization": {
    "id": 0,
    "name": "string",
    "type": "string",
    "aliases": [
      {
        "created": "string",
        "systemId": "string",
        "systemName": "string",
        "organizationId": 0
      }
    ],
    "contact": "string",
    "created": "string",
    "domains": [
      {
        "domain": "string",
        "created": "string",
        "domainId": 0,
        "modified": "string",
        "createdBy": "string",
        "isVerified": false,
        "modifiedBy": "string",
        "organizationId": 0,
        "verificationCode": "string",
        "verificationMethod": "string",
        "ownerOrganizationId": 0,
        "authenticationMethod": "string",
        "verificationCodeExpires": "string"
      }
    ],
    "members": [
      {
        "id": "string",
        "user": null,
        "roles": [],
        "userId": "string",
        "created": "string",
        "isGuest": false,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "isMfaRequired": false,
        "organizationId": 0,
        "organizationName": "string",
        "isMembershipMfaRequired": false,
        "organizationDisplayName": "string"
      }
    ],
    "isActive": false,
    "modified": "string",
    "products": [
      {
        "id": 0,
        "url": "string",
        "name": "string",
        "created": "string",
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "displayName": "string",
        "applications": [],
        "organization": null,
        "subscriptions": [],
        "organizationId": 0,
        "publicMetadata": null,
        "longDescription": "string"
      }
    ],
    "createdBy": "string",
    "modifiedBy": "string",
    "allowUpsell": false,
    "displayName": "string",
    "applications": [
      {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      }
    ],
    "crmAccountId": "string",
    "isMfaRequired": false,
    "isSelfService": false,
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      }
    ],
    "technicalContact": "string",
    "isEnabledForPreviewFeatures": false,
    "isDomainVerificationRequired": false
  },
  "isMfaDisabled": false,
  "subscriptions": [
    {
      "id": 0,
      "logs": [
        {
          "severity": null,
          "subscription": null
        }
      ],
      "type": "string",
      "status": "string",
      "created": "string",
      "details": "string",
      "expires": "string",
      "product": {
        "id": 0,
        "url": "string",
        "name": "string",
        "created": "string",
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "displayName": "string",
        "applications": [],
        "organization": null,
        "subscriptions": [],
        "organizationId": 0,
        "publicMetadata": null,
        "longDescription": "string"
      },
      "modified": "string",
      "createdBy": "string",
      "isEnabled": false,
      "productId": 0,
      "modifiedBy": "string",
      "statusText": "string",
      "description": "string",
      "organization": {
        "id": 0,
        "name": "string",
        "type": null,
        "aliases": [],
        "contact": "string",
        "created": "string",
        "domains": [],
        "members": [],
        "isActive": false,
        "modified": "string",
        "products": [],
        "createdBy": "string",
        "modifiedBy": "string",
        "allowUpsell": false,
        "displayName": "string",
        "applications": [],
        "crmAccountId": "string",
        "isMfaRequired": false,
        "isSelfService": false,
        "subscriptions": [],
        "technicalContact": "string",
        "isEnabledForPreviewFeatures": false,
        "isDomainVerificationRequired": false
      },
      "customMetadata": {},
      "organizationId": 0,
      "readonlyMetadata": {},
      "applicationDeployments": [
        {
          "application": null,
          "subscription": null,
          "customMetadata": null,
          "deploymentTarget": null,
          "readonlyMetadata": null
        }
      ]
    }
  ],
  "email-verified": false,
  "organizationId": 0,
  "mfaEnrollmentStatus": "string",
  "authenticationMethod": "string",
  "recoveryEmailAddress": "string",
  "applicationDeployments": [
    {
      "id": 0,
      "name": "string",
      "steps": [
        {}
      ],
      "status": "string",
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "application": {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      },
      "displayName": "string",
      "maxUserCount": 0,
      "subscription": {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      },
      "applicationId": 0,
      "configuration": "string",
      "customMetadata": {},
      "subscriptionId": 0,
      "deploymentTarget": {
        "id": 0,
        "name": "string",
        "country": "string",
        "created": "string",
        "details": null,
        "isActive": false,
        "modified": "string",
        "createdBy": "string",
        "publicUrl": "string",
        "modifiedBy": "string",
        "application": null,
        "description": "string",
        "displayName": "string",
        "environment": "string",
        "applicationId": 0
      },
      "readonlyMetadata": {},
      "statusResolution": "string",
      "deploymentTargetId": 0
    }
  ],
  "email-verify-sent-date": "string",
  "email-verification-status-type": "string"
}
Schema
Name Type Attributes Description Extensions
displayName string required A display name to use when showing the user information to admins and other users.
minLength: 1 · maxLength: 250
 —
emailAddress string required The user's email address. This value will be used as the primary method of identifying a user on sign-in. <list type="bullet"><item> This value must be globally unique. </item><item> This value must adhere to the format 'user@domain' </item><item> The email address is not validated (by default). </item></list>
minLength: 1 · maxLength: 250
 —
applicationDeployments nullable — —
attributes nullable — —
authenticationMethod AuthenticationMethod — A list of methods by which a user can authenticate.
Value Description
Database —
Ad —
Federation —
Email —
Sms —
—
created string (date-time) nullable The date the user was created (in UTC). —
createdBy string nullable The identifier of the principal that created the user. —
customUpns nullable — —
email-verification-status-type EmailStatusType — —
Value Description
Unsent —
Pending —
Accepted —
Expired —
—
email-verified boolean — — —
email-verify-sent-date string (date-time) nullable — —
familyName string nullable The users family or last name.
maxLength: 200
 —
givenName string nullable The users given or first name.
maxLength: 200
 —
id string nullable The system assigned unique identifier. —
identities nullable The collection of tenants where this user exists. Only applies to federated or social users. —
isActive boolean nullable Indicates if the user's account is active. —
isMfaDisabled boolean nullable Indicates if the user is required to use multi-factor authentication. This is only applicable if Nexus.Backend.Domain.User.UserModel.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. —
language string nullable The user who owns the device. —
memberOf nullable The list of organizations the user is a member of —
mfaEnrollmentStatus string nullable The user who owns the device. —
modified string (date-time) nullable The date the user was last modified (in UTC). —
modifiedBy string nullable The identifier of the principal that last modified the user. —
nickname string nullable A nickname for the user.
maxLength: 200
 —
organization — Represents an Organization —
organizationId integer (int32) nullable The organization to which the user belongs. —
owner — — —
ownerId string nullable The user who owns the device. —
phoneNumber string nullable A phone number for the user. This number may be used for SMS based MFA.
maxLength: 50
 —
picture string nullable A URL to a picture of the user.
maxLength: 250
 —
recoveryEmailAddress string nullable The user's email address for account recovery purposes. This value is not required. If not provided, the Nexus.Backend.Domain.User.UserModel.EmailAddress will be used. —
roles nullable List of user roles —
subscriptions nullable — —
type UserType — Defines a list of valid principal types.
Value Description
Person —
Device —
—
username string nullable A nickname for the user.
maxLength: 200
 —
Example 
{
  "id": "string",
  "type": "string",
  "owner": {
    "id": "string",
    "type": "string",
    "owner": {
      "id": "string",
      "type": "string",
      "owner": {
        "type": null,
        "owner": null,
        "organization": null,
        "authenticationMethod": null,
        "email-verification-status-type": null
      },
      "roles": [],
      "created": "string",
      "ownerId": "string",
      "picture": "string",
      "isActive": false,
      "language": "string",
      "memberOf": [],
      "modified": "string",
      "nickname": "string",
      "username": "string",
      "createdBy": "string",
      "givenName": "string",
      "attributes": [],
      "customUpns": [],
      "familyName": "string",
      "identities": [],
      "modifiedBy": "string",
      "displayName": "Justin Buchanan",
      "phoneNumber": "string",
      "emailAddress": "justin@example.com",
      "organization": {
        "type": null
      },
      "isMfaDisabled": false,
      "subscriptions": [],
      "email-verified": false,
      "organizationId": 0,
      "mfaEnrollmentStatus": "string",
      "authenticationMethod": "string",
      "recoveryEmailAddress": "string",
      "applicationDeployments": [],
      "email-verify-sent-date": "string",
      "email-verification-status-type": "string"
    },
    "roles": [
      {
        "id": "string",
        "name": "string",
        "expires": "string",
        "description": "string"
      }
    ],
    "created": "string",
    "ownerId": "string",
    "picture": "string",
    "isActive": false,
    "language": "string",
    "memberOf": [
      {
        "id": "string",
        "user": null,
        "roles": [],
        "userId": "string",
        "created": "string",
        "isGuest": false,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "isMfaRequired": false,
        "organizationId": 0,
        "organizationName": "string",
        "isMembershipMfaRequired": false,
        "organizationDisplayName": "string"
      }
    ],
    "modified": "string",
    "nickname": "string",
    "username": "string",
    "createdBy": "string",
    "givenName": "string",
    "attributes": [
      {
        "id": 0,
        "name": "string",
        "value": "string",
        "userId": "string",
        "expires": "string"
      }
    ],
    "customUpns": [
      {
        "id": "string",
        "userId": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "clientUpnKey": "string",
        "customUpnValue": "string"
      }
    ],
    "familyName": "string",
    "identities": [
      {
        "id": 0,
        "groups": [],
        "strategy": "string",
        "azoUserId": "string",
        "idpTenantId": 0,
        "loginDomain": "string",
        "azoTenantName": "string",
        "idpTenantFqdn": "string",
        "idpTenantName": "string",
        "azoConnectionId": "string"
      }
    ],
    "modifiedBy": "string",
    "displayName": "Justin Buchanan",
    "phoneNumber": "string",
    "emailAddress": "justin@example.com",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "aliases": [],
      "contact": "string",
      "created": "string",
      "domains": [],
      "members": [],
      "isActive": false,
      "modified": "string",
      "products": [],
      "createdBy": "string",
      "modifiedBy": "string",
      "allowUpsell": false,
      "displayName": "string",
      "applications": [],
      "crmAccountId": "string",
      "isMfaRequired": false,
      "isSelfService": false,
      "subscriptions": [],
      "technicalContact": "string",
      "isEnabledForPreviewFeatures": false,
      "isDomainVerificationRequired": false
    },
    "isMfaDisabled": false,
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      }
    ],
    "email-verified": false,
    "organizationId": 0,
    "mfaEnrollmentStatus": "string",
    "authenticationMethod": "string",
    "recoveryEmailAddress": "string",
    "applicationDeployments": [
      {
        "id": 0,
        "name": "string",
        "steps": [],
        "status": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "application": null,
        "displayName": "string",
        "maxUserCount": 0,
        "subscription": null,
        "applicationId": 0,
        "configuration": "string",
        "customMetadata": null,
        "subscriptionId": 0,
        "deploymentTarget": null,
        "readonlyMetadata": null,
        "statusResolution": "string",
        "deploymentTargetId": 0
      }
    ],
    "email-verify-sent-date": "string",
    "email-verification-status-type": "string"
  },
  "roles": [
    {
      "id": "string",
      "name": "string",
      "expires": "string",
      "description": "string"
    }
  ],
  "created": "string",
  "ownerId": "string",
  "picture": "string",
  "isActive": false,
  "language": "string",
  "memberOf": [
    {
      "id": "string",
      "user": {
        "id": "string",
        "type": null,
        "owner": null,
        "roles": [],
        "created": "string",
        "ownerId": "string",
        "picture": "string",
        "isActive": false,
        "language": "string",
        "memberOf": [],
        "modified": "string",
        "nickname": "string",
        "username": "string",
        "createdBy": "string",
        "givenName": "string",
        "attributes": [],
        "customUpns": [],
        "familyName": "string",
        "identities": [],
        "modifiedBy": "string",
        "displayName": "Justin Buchanan",
        "phoneNumber": "string",
        "emailAddress": "justin@example.com",
        "organization": null,
        "isMfaDisabled": false,
        "subscriptions": [],
        "email-verified": false,
        "organizationId": 0,
        "mfaEnrollmentStatus": "string",
        "authenticationMethod": null,
        "recoveryEmailAddress": "string",
        "applicationDeployments": [],
        "email-verify-sent-date": "string",
        "email-verification-status-type": null
      },
      "roles": [
        {}
      ],
      "userId": "string",
      "created": "string",
      "isGuest": false,
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "isMfaRequired": false,
      "organizationId": 0,
      "organizationName": "string",
      "isMembershipMfaRequired": false,
      "organizationDisplayName": "string"
    }
  ],
  "modified": "string",
  "nickname": "string",
  "username": "string",
  "createdBy": "string",
  "givenName": "string",
  "attributes": [
    {
      "id": 0,
      "name": "string",
      "value": "string",
      "userId": "string",
      "expires": "string"
    }
  ],
  "customUpns": [
    {
      "id": "string",
      "userId": "string",
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "clientUpnKey": "string",
      "customUpnValue": "string"
    }
  ],
  "familyName": "string",
  "identities": [
    {
      "id": 0,
      "groups": [
        {}
      ],
      "strategy": "string",
      "azoUserId": "string",
      "idpTenantId": 0,
      "loginDomain": "string",
      "azoTenantName": "string",
      "idpTenantFqdn": "string",
      "idpTenantName": "string",
      "azoConnectionId": "string"
    }
  ],
  "modifiedBy": "string",
  "displayName": "Justin Buchanan",
  "phoneNumber": "string",
  "emailAddress": "justin@example.com",
  "organization": {
    "id": 0,
    "name": "string",
    "type": "string",
    "aliases": [
      {
        "created": "string",
        "systemId": "string",
        "systemName": "string",
        "organizationId": 0
      }
    ],
    "contact": "string",
    "created": "string",
    "domains": [
      {
        "domain": "string",
        "created": "string",
        "domainId": 0,
        "modified": "string",
        "createdBy": "string",
        "isVerified": false,
        "modifiedBy": "string",
        "organizationId": 0,
        "verificationCode": "string",
        "verificationMethod": "string",
        "ownerOrganizationId": 0,
        "authenticationMethod": "string",
        "verificationCodeExpires": "string"
      }
    ],
    "members": [
      {
        "id": "string",
        "user": null,
        "roles": [],
        "userId": "string",
        "created": "string",
        "isGuest": false,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "isMfaRequired": false,
        "organizationId": 0,
        "organizationName": "string",
        "isMembershipMfaRequired": false,
        "organizationDisplayName": "string"
      }
    ],
    "isActive": false,
    "modified": "string",
    "products": [
      {
        "id": 0,
        "url": "string",
        "name": "string",
        "created": "string",
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "displayName": "string",
        "applications": [],
        "organization": null,
        "subscriptions": [],
        "organizationId": 0,
        "publicMetadata": null,
        "longDescription": "string"
      }
    ],
    "createdBy": "string",
    "modifiedBy": "string",
    "allowUpsell": false,
    "displayName": "string",
    "applications": [
      {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      }
    ],
    "crmAccountId": "string",
    "isMfaRequired": false,
    "isSelfService": false,
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      }
    ],
    "technicalContact": "string",
    "isEnabledForPreviewFeatures": false,
    "isDomainVerificationRequired": false
  },
  "isMfaDisabled": false,
  "subscriptions": [
    {
      "id": 0,
      "logs": [
        {
          "severity": null,
          "subscription": null
        }
      ],
      "type": "string",
      "status": "string",
      "created": "string",
      "details": "string",
      "expires": "string",
      "product": {
        "id": 0,
        "url": "string",
        "name": "string",
        "created": "string",
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "displayName": "string",
        "applications": [],
        "organization": null,
        "subscriptions": [],
        "organizationId": 0,
        "publicMetadata": null,
        "longDescription": "string"
      },
      "modified": "string",
      "createdBy": "string",
      "isEnabled": false,
      "productId": 0,
      "modifiedBy": "string",
      "statusText": "string",
      "description": "string",
      "organization": {
        "id": 0,
        "name": "string",
        "type": null,
        "aliases": [],
        "contact": "string",
        "created": "string",
        "domains": [],
        "members": [],
        "isActive": false,
        "modified": "string",
        "products": [],
        "createdBy": "string",
        "modifiedBy": "string",
        "allowUpsell": false,
        "displayName": "string",
        "applications": [],
        "crmAccountId": "string",
        "isMfaRequired": false,
        "isSelfService": false,
        "subscriptions": [],
        "technicalContact": "string",
        "isEnabledForPreviewFeatures": false,
        "isDomainVerificationRequired": false
      },
      "customMetadata": {},
      "organizationId": 0,
      "readonlyMetadata": {},
      "applicationDeployments": [
        {
          "application": null,
          "subscription": null,
          "customMetadata": null,
          "deploymentTarget": null,
          "readonlyMetadata": null
        }
      ]
    }
  ],
  "email-verified": false,
  "organizationId": 0,
  "mfaEnrollmentStatus": "string",
  "authenticationMethod": "string",
  "recoveryEmailAddress": "string",
  "applicationDeployments": [
    {
      "id": 0,
      "name": "string",
      "steps": [
        {}
      ],
      "status": "string",
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "application": {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      },
      "displayName": "string",
      "maxUserCount": 0,
      "subscription": {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      },
      "applicationId": 0,
      "configuration": "string",
      "customMetadata": {},
      "subscriptionId": 0,
      "deploymentTarget": {
        "id": 0,
        "name": "string",
        "country": "string",
        "created": "string",
        "details": null,
        "isActive": false,
        "modified": "string",
        "createdBy": "string",
        "publicUrl": "string",
        "modifiedBy": "string",
        "application": null,
        "description": "string",
        "displayName": "string",
        "environment": "string",
        "applicationId": 0
      },
      "readonlyMetadata": {},
      "statusResolution": "string",
      "deploymentTargetId": 0
    }
  ],
  "email-verify-sent-date": "string",
  "email-verification-status-type": "string"
}
Schema
Name Type Attributes Description Extensions
displayName string required A display name to use when showing the user information to admins and other users.
minLength: 1 · maxLength: 250
 —
emailAddress string required The user's email address. This value will be used as the primary method of identifying a user on sign-in. <list type="bullet"><item> This value must be globally unique. </item><item> This value must adhere to the format 'user@domain' </item><item> The email address is not validated (by default). </item></list>
minLength: 1 · maxLength: 250
 —
applicationDeployments nullable — —
attributes nullable — —
authenticationMethod AuthenticationMethod — A list of methods by which a user can authenticate.
Value Description
Database —
Ad —
Federation —
Email —
Sms —
—
created string (date-time) nullable The date the user was created (in UTC). —
createdBy string nullable The identifier of the principal that created the user. —
customUpns nullable — —
email-verification-status-type EmailStatusType — —
Value Description
Unsent —
Pending —
Accepted —
Expired —
—
email-verified boolean — — —
email-verify-sent-date string (date-time) nullable — —
familyName string nullable The users family or last name.
maxLength: 200
 —
givenName string nullable The users given or first name.
maxLength: 200
 —
id string nullable The system assigned unique identifier. —
identities nullable The collection of tenants where this user exists. Only applies to federated or social users. —
isActive boolean nullable Indicates if the user's account is active. —
isMfaDisabled boolean nullable Indicates if the user is required to use multi-factor authentication. This is only applicable if Nexus.Backend.Domain.User.UserModel.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. —
language string nullable The user who owns the device. —
memberOf nullable The list of organizations the user is a member of —
mfaEnrollmentStatus string nullable The user who owns the device. —
modified string (date-time) nullable The date the user was last modified (in UTC). —
modifiedBy string nullable The identifier of the principal that last modified the user. —
nickname string nullable A nickname for the user.
maxLength: 200
 —
organization — Represents an Organization —
organizationId integer (int32) nullable The organization to which the user belongs. —
owner — — —
ownerId string nullable The user who owns the device. —
phoneNumber string nullable A phone number for the user. This number may be used for SMS based MFA.
maxLength: 50
 —
picture string nullable A URL to a picture of the user.
maxLength: 250
 —
recoveryEmailAddress string nullable The user's email address for account recovery purposes. This value is not required. If not provided, the Nexus.Backend.Domain.User.UserModel.EmailAddress will be used. —
roles nullable List of user roles —
subscriptions nullable — —
type UserType — Defines a list of valid principal types.
Value Description
Person —
Device —
—
username string nullable A nickname for the user.
maxLength: 200
 —
Example 
{
  "id": "string",
  "type": "string",
  "owner": {
    "id": "string",
    "type": "string",
    "owner": {
      "id": "string",
      "type": "string",
      "owner": {
        "type": null,
        "owner": null,
        "organization": null,
        "authenticationMethod": null,
        "email-verification-status-type": null
      },
      "roles": [],
      "created": "string",
      "ownerId": "string",
      "picture": "string",
      "isActive": false,
      "language": "string",
      "memberOf": [],
      "modified": "string",
      "nickname": "string",
      "username": "string",
      "createdBy": "string",
      "givenName": "string",
      "attributes": [],
      "customUpns": [],
      "familyName": "string",
      "identities": [],
      "modifiedBy": "string",
      "displayName": "Justin Buchanan",
      "phoneNumber": "string",
      "emailAddress": "justin@example.com",
      "organization": {
        "type": null
      },
      "isMfaDisabled": false,
      "subscriptions": [],
      "email-verified": false,
      "organizationId": 0,
      "mfaEnrollmentStatus": "string",
      "authenticationMethod": "string",
      "recoveryEmailAddress": "string",
      "applicationDeployments": [],
      "email-verify-sent-date": "string",
      "email-verification-status-type": "string"
    },
    "roles": [
      {
        "id": "string",
        "name": "string",
        "expires": "string",
        "description": "string"
      }
    ],
    "created": "string",
    "ownerId": "string",
    "picture": "string",
    "isActive": false,
    "language": "string",
    "memberOf": [
      {
        "id": "string",
        "user": null,
        "roles": [],
        "userId": "string",
        "created": "string",
        "isGuest": false,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "isMfaRequired": false,
        "organizationId": 0,
        "organizationName": "string",
        "isMembershipMfaRequired": false,
        "organizationDisplayName": "string"
      }
    ],
    "modified": "string",
    "nickname": "string",
    "username": "string",
    "createdBy": "string",
    "givenName": "string",
    "attributes": [
      {
        "id": 0,
        "name": "string",
        "value": "string",
        "userId": "string",
        "expires": "string"
      }
    ],
    "customUpns": [
      {
        "id": "string",
        "userId": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "clientUpnKey": "string",
        "customUpnValue": "string"
      }
    ],
    "familyName": "string",
    "identities": [
      {
        "id": 0,
        "groups": [],
        "strategy": "string",
        "azoUserId": "string",
        "idpTenantId": 0,
        "loginDomain": "string",
        "azoTenantName": "string",
        "idpTenantFqdn": "string",
        "idpTenantName": "string",
        "azoConnectionId": "string"
      }
    ],
    "modifiedBy": "string",
    "displayName": "Justin Buchanan",
    "phoneNumber": "string",
    "emailAddress": "justin@example.com",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "aliases": [],
      "contact": "string",
      "created": "string",
      "domains": [],
      "members": [],
      "isActive": false,
      "modified": "string",
      "products": [],
      "createdBy": "string",
      "modifiedBy": "string",
      "allowUpsell": false,
      "displayName": "string",
      "applications": [],
      "crmAccountId": "string",
      "isMfaRequired": false,
      "isSelfService": false,
      "subscriptions": [],
      "technicalContact": "string",
      "isEnabledForPreviewFeatures": false,
      "isDomainVerificationRequired": false
    },
    "isMfaDisabled": false,
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      }
    ],
    "email-verified": false,
    "organizationId": 0,
    "mfaEnrollmentStatus": "string",
    "authenticationMethod": "string",
    "recoveryEmailAddress": "string",
    "applicationDeployments": [
      {
        "id": 0,
        "name": "string",
        "steps": [],
        "status": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "application": null,
        "displayName": "string",
        "maxUserCount": 0,
        "subscription": null,
        "applicationId": 0,
        "configuration": "string",
        "customMetadata": null,
        "subscriptionId": 0,
        "deploymentTarget": null,
        "readonlyMetadata": null,
        "statusResolution": "string",
        "deploymentTargetId": 0
      }
    ],
    "email-verify-sent-date": "string",
    "email-verification-status-type": "string"
  },
  "roles": [
    {
      "id": "string",
      "name": "string",
      "expires": "string",
      "description": "string"
    }
  ],
  "created": "string",
  "ownerId": "string",
  "picture": "string",
  "isActive": false,
  "language": "string",
  "memberOf": [
    {
      "id": "string",
      "user": {
        "id": "string",
        "type": null,
        "owner": null,
        "roles": [],
        "created": "string",
        "ownerId": "string",
        "picture": "string",
        "isActive": false,
        "language": "string",
        "memberOf": [],
        "modified": "string",
        "nickname": "string",
        "username": "string",
        "createdBy": "string",
        "givenName": "string",
        "attributes": [],
        "customUpns": [],
        "familyName": "string",
        "identities": [],
        "modifiedBy": "string",
        "displayName": "Justin Buchanan",
        "phoneNumber": "string",
        "emailAddress": "justin@example.com",
        "organization": null,
        "isMfaDisabled": false,
        "subscriptions": [],
        "email-verified": false,
        "organizationId": 0,
        "mfaEnrollmentStatus": "string",
        "authenticationMethod": null,
        "recoveryEmailAddress": "string",
        "applicationDeployments": [],
        "email-verify-sent-date": "string",
        "email-verification-status-type": null
      },
      "roles": [
        {}
      ],
      "userId": "string",
      "created": "string",
      "isGuest": false,
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "isMfaRequired": false,
      "organizationId": 0,
      "organizationName": "string",
      "isMembershipMfaRequired": false,
      "organizationDisplayName": "string"
    }
  ],
  "modified": "string",
  "nickname": "string",
  "username": "string",
  "createdBy": "string",
  "givenName": "string",
  "attributes": [
    {
      "id": 0,
      "name": "string",
      "value": "string",
      "userId": "string",
      "expires": "string"
    }
  ],
  "customUpns": [
    {
      "id": "string",
      "userId": "string",
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "clientUpnKey": "string",
      "customUpnValue": "string"
    }
  ],
  "familyName": "string",
  "identities": [
    {
      "id": 0,
      "groups": [
        {}
      ],
      "strategy": "string",
      "azoUserId": "string",
      "idpTenantId": 0,
      "loginDomain": "string",
      "azoTenantName": "string",
      "idpTenantFqdn": "string",
      "idpTenantName": "string",
      "azoConnectionId": "string"
    }
  ],
  "modifiedBy": "string",
  "displayName": "Justin Buchanan",
  "phoneNumber": "string",
  "emailAddress": "justin@example.com",
  "organization": {
    "id": 0,
    "name": "string",
    "type": "string",
    "aliases": [
      {
        "created": "string",
        "systemId": "string",
        "systemName": "string",
        "organizationId": 0
      }
    ],
    "contact": "string",
    "created": "string",
    "domains": [
      {
        "domain": "string",
        "created": "string",
        "domainId": 0,
        "modified": "string",
        "createdBy": "string",
        "isVerified": false,
        "modifiedBy": "string",
        "organizationId": 0,
        "verificationCode": "string",
        "verificationMethod": "string",
        "ownerOrganizationId": 0,
        "authenticationMethod": "string",
        "verificationCodeExpires": "string"
      }
    ],
    "members": [
      {
        "id": "string",
        "user": null,
        "roles": [],
        "userId": "string",
        "created": "string",
        "isGuest": false,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "isMfaRequired": false,
        "organizationId": 0,
        "organizationName": "string",
        "isMembershipMfaRequired": false,
        "organizationDisplayName": "string"
      }
    ],
    "isActive": false,
    "modified": "string",
    "products": [
      {
        "id": 0,
        "url": "string",
        "name": "string",
        "created": "string",
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "displayName": "string",
        "applications": [],
        "organization": null,
        "subscriptions": [],
        "organizationId": 0,
        "publicMetadata": null,
        "longDescription": "string"
      }
    ],
    "createdBy": "string",
    "modifiedBy": "string",
    "allowUpsell": false,
    "displayName": "string",
    "applications": [
      {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      }
    ],
    "crmAccountId": "string",
    "isMfaRequired": false,
    "isSelfService": false,
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      }
    ],
    "technicalContact": "string",
    "isEnabledForPreviewFeatures": false,
    "isDomainVerificationRequired": false
  },
  "isMfaDisabled": false,
  "subscriptions": [
    {
      "id": 0,
      "logs": [
        {
          "severity": null,
          "subscription": null
        }
      ],
      "type": "string",
      "status": "string",
      "created": "string",
      "details": "string",
      "expires": "string",
      "product": {
        "id": 0,
        "url": "string",
        "name": "string",
        "created": "string",
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "displayName": "string",
        "applications": [],
        "organization": null,
        "subscriptions": [],
        "organizationId": 0,
        "publicMetadata": null,
        "longDescription": "string"
      },
      "modified": "string",
      "createdBy": "string",
      "isEnabled": false,
      "productId": 0,
      "modifiedBy": "string",
      "statusText": "string",
      "description": "string",
      "organization": {
        "id": 0,
        "name": "string",
        "type": null,
        "aliases": [],
        "contact": "string",
        "created": "string",
        "domains": [],
        "members": [],
        "isActive": false,
        "modified": "string",
        "products": [],
        "createdBy": "string",
        "modifiedBy": "string",
        "allowUpsell": false,
        "displayName": "string",
        "applications": [],
        "crmAccountId": "string",
        "isMfaRequired": false,
        "isSelfService": false,
        "subscriptions": [],
        "technicalContact": "string",
        "isEnabledForPreviewFeatures": false,
        "isDomainVerificationRequired": false
      },
      "customMetadata": {},
      "organizationId": 0,
      "readonlyMetadata": {},
      "applicationDeployments": [
        {
          "application": null,
          "subscription": null,
          "customMetadata": null,
          "deploymentTarget": null,
          "readonlyMetadata": null
        }
      ]
    }
  ],
  "email-verified": false,
  "organizationId": 0,
  "mfaEnrollmentStatus": "string",
  "authenticationMethod": "string",
  "recoveryEmailAddress": "string",
  "applicationDeployments": [
    {
      "id": 0,
      "name": "string",
      "steps": [
        {}
      ],
      "status": "string",
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "application": {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      },
      "displayName": "string",
      "maxUserCount": 0,
      "subscription": {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "organization": null,
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "applicationDeployments": []
      },
      "applicationId": 0,
      "configuration": "string",
      "customMetadata": {},
      "subscriptionId": 0,
      "deploymentTarget": {
        "id": 0,
        "name": "string",
        "country": "string",
        "created": "string",
        "details": null,
        "isActive": false,
        "modified": "string",
        "createdBy": "string",
        "publicUrl": "string",
        "modifiedBy": "string",
        "application": null,
        "description": "string",
        "displayName": "string",
        "environment": "string",
        "applicationId": 0
      },
      "readonlyMetadata": {},
      "statusResolution": "string",
      "deploymentTargetId": 0
    }
  ],
  "email-verify-sent-date": "string",
  "email-verification-status-type": "string"
}
Schema
Name Type Attributes Description Extensions
displayName string required A display name to use when showing the user information to admins and other users.
minLength: 1 · maxLength: 250
 —
emailAddress string required The user's email address. This value will be used as the primary method of identifying a user on sign-in. <list type="bullet"><item> This value must be globally unique. </item><item> This value must adhere to the format 'user@domain' </item><item> The email address is not validated (by default). </item></list>
minLength: 1 · maxLength: 250
 —
applicationDeployments nullable — —
attributes nullable — —
authenticationMethod AuthenticationMethod — A list of methods by which a user can authenticate.
Value Description
Database —
Ad —
Federation —
Email —
Sms —
—
created string (date-time) nullable The date the user was created (in UTC). —
createdBy string nullable The identifier of the principal that created the user. —
customUpns nullable — —
email-verification-status-type EmailStatusType — —
Value Description
Unsent —
Pending —
Accepted —
Expired —
—
email-verified boolean — — —
email-verify-sent-date string (date-time) nullable — —
familyName string nullable The users family or last name.
maxLength: 200
 —
givenName string nullable The users given or first name.
maxLength: 200
 —
id string nullable The system assigned unique identifier. —
identities nullable The collection of tenants where this user exists. Only applies to federated or social users. —
isActive boolean nullable Indicates if the user's account is active. —
isMfaDisabled boolean nullable Indicates if the user is required to use multi-factor authentication. This is only applicable if Nexus.Backend.Domain.User.UserModel.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. —
language string nullable The user who owns the device. —
memberOf nullable The list of organizations the user is a member of —
mfaEnrollmentStatus string nullable The user who owns the device. —
modified string (date-time) nullable The date the user was last modified (in UTC). —
modifiedBy string nullable The identifier of the principal that last modified the user. —
nickname string nullable A nickname for the user.
maxLength: 200
 —
organization — Represents an Organization —
organizationId integer (int32) nullable The organization to which the user belongs. —
owner — — —
ownerId string nullable The user who owns the device. —
phoneNumber string nullable A phone number for the user. This number may be used for SMS based MFA.
maxLength: 50
 —
picture string nullable A URL to a picture of the user.
maxLength: 250
 —
recoveryEmailAddress string nullable The user's email address for account recovery purposes. This value is not required. If not provided, the Nexus.Backend.Domain.User.UserModel.EmailAddress will be used. —
roles nullable List of user roles —
subscriptions nullable — —
type UserType — Defines a list of valid principal types.
Value Description
Person —
Device —
—
username string nullable A nickname for the user.
maxLength: 200
 —
404
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Security

Authentication is required for this operation.

Source: default

Requirements (any one option may satisfy)

  • Bearer and ApplicationToken
  • Basic

Try it