Nexus
Nexus APIs
POST
/v1/organizations
Creates an Organization
Requires the organization.write permission
Request body
Request payload
Example
{
"name": "Welcome Woods Inc.",
"type": "string",
"contact": "string",
"displayName": "Welcome Woods Inc.",
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"technicalContact": "string",
"isEnabledForPreviewFeatures": false
}Schema
| Name | Type | Attributes | Description | Extensions | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
crmAccountId
|
string
|
required |
The CRM account identifier.
minLength: 1 · maxLength: 250
|
— | ||||||||||
displayName
|
string
|
required |
Name of the organization
minLength: 1 · maxLength: 250
|
— | ||||||||||
name
|
string
|
required |
Name of the organization
minLength: 1 · maxLength: 250
|
— | ||||||||||
type
|
OrganizationType
|
required |
Defines a list of valid organization types.
|
— | ||||||||||
contact
|
string
|
nullable |
The general contact information for the organization.
maxLength: 250
|
— | ||||||||||
isEnabledForPreviewFeatures
|
boolean
|
— | This flag has no defined purpose in Nexus and is used by applications to determine if a customer should have access to preview features. | — | ||||||||||
isMfaRequired
|
boolean
|
— | Indicates if users in the organization are required to enroll and use multi-factor authentication | — | ||||||||||
isSelfService
|
boolean
|
— | Indicates this organization was created as part of a self-service product onboarding or demonstration flow. | — | ||||||||||
technicalContact
|
string
|
nullable |
The technical contact information for the organization.
maxLength: 250
|
— |
Example
{
"name": "Welcome Woods Inc.",
"type": "string",
"contact": "string",
"displayName": "Welcome Woods Inc.",
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"technicalContact": "string",
"isEnabledForPreviewFeatures": false
}Schema
| Name | Type | Attributes | Description | Extensions | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
crmAccountId
|
string
|
required |
The CRM account identifier.
minLength: 1 · maxLength: 250
|
— | ||||||||||
displayName
|
string
|
required |
Name of the organization
minLength: 1 · maxLength: 250
|
— | ||||||||||
name
|
string
|
required |
Name of the organization
minLength: 1 · maxLength: 250
|
— | ||||||||||
type
|
OrganizationType
|
required |
Defines a list of valid organization types.
|
— | ||||||||||
contact
|
string
|
nullable |
The general contact information for the organization.
maxLength: 250
|
— | ||||||||||
isEnabledForPreviewFeatures
|
boolean
|
— | This flag has no defined purpose in Nexus and is used by applications to determine if a customer should have access to preview features. | — | ||||||||||
isMfaRequired
|
boolean
|
— | Indicates if users in the organization are required to enroll and use multi-factor authentication | — | ||||||||||
isSelfService
|
boolean
|
— | Indicates this organization was created as part of a self-service product onboarding or demonstration flow. | — | ||||||||||
technicalContact
|
string
|
nullable |
The technical contact information for the organization.
maxLength: 250
|
— |
Example
{
"name": "Welcome Woods Inc.",
"type": "string",
"contact": "string",
"displayName": "Welcome Woods Inc.",
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"technicalContact": "string",
"isEnabledForPreviewFeatures": false
}Schema
| Name | Type | Attributes | Description | Extensions | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
crmAccountId
|
string
|
required |
The CRM account identifier.
minLength: 1 · maxLength: 250
|
— | ||||||||||
displayName
|
string
|
required |
Name of the organization
minLength: 1 · maxLength: 250
|
— | ||||||||||
name
|
string
|
required |
Name of the organization
minLength: 1 · maxLength: 250
|
— | ||||||||||
type
|
OrganizationType
|
required |
Defines a list of valid organization types.
|
— | ||||||||||
contact
|
string
|
nullable |
The general contact information for the organization.
maxLength: 250
|
— | ||||||||||
isEnabledForPreviewFeatures
|
boolean
|
— | This flag has no defined purpose in Nexus and is used by applications to determine if a customer should have access to preview features. | — | ||||||||||
isMfaRequired
|
boolean
|
— | Indicates if users in the organization are required to enroll and use multi-factor authentication | — | ||||||||||
isSelfService
|
boolean
|
— | Indicates this organization was created as part of a self-service product onboarding or demonstration flow. | — | ||||||||||
technicalContact
|
string
|
nullable |
The technical contact information for the organization.
maxLength: 250
|
— |
Example
{
"name": "Welcome Woods Inc.",
"type": "string",
"contact": "string",
"displayName": "Welcome Woods Inc.",
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"technicalContact": "string",
"isEnabledForPreviewFeatures": false
}Schema
| Name | Type | Attributes | Description | Extensions | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
crmAccountId
|
string
|
required |
The CRM account identifier.
minLength: 1 · maxLength: 250
|
— | ||||||||||
displayName
|
string
|
required |
Name of the organization
minLength: 1 · maxLength: 250
|
— | ||||||||||
name
|
string
|
required |
Name of the organization
minLength: 1 · maxLength: 250
|
— | ||||||||||
type
|
OrganizationType
|
required |
Defines a list of valid organization types.
|
— | ||||||||||
contact
|
string
|
nullable |
The general contact information for the organization.
maxLength: 250
|
— | ||||||||||
isEnabledForPreviewFeatures
|
boolean
|
— | This flag has no defined purpose in Nexus and is used by applications to determine if a customer should have access to preview features. | — | ||||||||||
isMfaRequired
|
boolean
|
— | Indicates if users in the organization are required to enroll and use multi-factor authentication | — | ||||||||||
isSelfService
|
boolean
|
— | Indicates this organization was created as part of a self-service product onboarding or demonstration flow. | — | ||||||||||
technicalContact
|
string
|
nullable |
The technical contact information for the organization.
maxLength: 250
|
— |
Example
{
"name": "Welcome Woods Inc.",
"type": "string",
"contact": "string",
"displayName": "Welcome Woods Inc.",
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"technicalContact": "string",
"isEnabledForPreviewFeatures": false
}Schema
| Name | Type | Attributes | Description | Extensions | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
crmAccountId
|
string
|
required |
The CRM account identifier.
minLength: 1 · maxLength: 250
|
— | ||||||||||
displayName
|
string
|
required |
Name of the organization
minLength: 1 · maxLength: 250
|
— | ||||||||||
name
|
string
|
required |
Name of the organization
minLength: 1 · maxLength: 250
|
— | ||||||||||
type
|
OrganizationType
|
required |
Defines a list of valid organization types.
|
— | ||||||||||
contact
|
string
|
nullable |
The general contact information for the organization.
maxLength: 250
|
— | ||||||||||
isEnabledForPreviewFeatures
|
boolean
|
— | This flag has no defined purpose in Nexus and is used by applications to determine if a customer should have access to preview features. | — | ||||||||||
isMfaRequired
|
boolean
|
— | Indicates if users in the organization are required to enroll and use multi-factor authentication | — | ||||||||||
isSelfService
|
boolean
|
— | Indicates this organization was created as part of a self-service product onboarding or demonstration flow. | — | ||||||||||
technicalContact
|
string
|
nullable |
The technical contact information for the organization.
maxLength: 250
|
— |
Example
{
"name": "Welcome Woods Inc.",
"type": "string",
"contact": "string",
"displayName": "Welcome Woods Inc.",
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"technicalContact": "string",
"isEnabledForPreviewFeatures": false
}Schema
| Name | Type | Attributes | Description | Extensions | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
crmAccountId
|
string
|
required |
The CRM account identifier.
minLength: 1 · maxLength: 250
|
— | ||||||||||
displayName
|
string
|
required |
Name of the organization
minLength: 1 · maxLength: 250
|
— | ||||||||||
name
|
string
|
required |
Name of the organization
minLength: 1 · maxLength: 250
|
— | ||||||||||
type
|
OrganizationType
|
required |
Defines a list of valid organization types.
|
— | ||||||||||
contact
|
string
|
nullable |
The general contact information for the organization.
maxLength: 250
|
— | ||||||||||
isEnabledForPreviewFeatures
|
boolean
|
— | This flag has no defined purpose in Nexus and is used by applications to determine if a customer should have access to preview features. | — | ||||||||||
isMfaRequired
|
boolean
|
— | Indicates if users in the organization are required to enroll and use multi-factor authentication | — | ||||||||||
isSelfService
|
boolean
|
— | Indicates this organization was created as part of a self-service product onboarding or demonstration flow. | — | ||||||||||
technicalContact
|
string
|
nullable |
The technical contact information for the organization.
maxLength: 250
|
— |
Example
{
"name": "Welcome Woods Inc.",
"type": "string",
"contact": "string",
"displayName": "Welcome Woods Inc.",
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"technicalContact": "string",
"isEnabledForPreviewFeatures": false
}Schema
| Name | Type | Attributes | Description | Extensions | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
crmAccountId
|
string
|
required |
The CRM account identifier.
minLength: 1 · maxLength: 250
|
— | ||||||||||
displayName
|
string
|
required |
Name of the organization
minLength: 1 · maxLength: 250
|
— | ||||||||||
name
|
string
|
required |
Name of the organization
minLength: 1 · maxLength: 250
|
— | ||||||||||
type
|
OrganizationType
|
required |
Defines a list of valid organization types.
|
— | ||||||||||
contact
|
string
|
nullable |
The general contact information for the organization.
maxLength: 250
|
— | ||||||||||
isEnabledForPreviewFeatures
|
boolean
|
— | This flag has no defined purpose in Nexus and is used by applications to determine if a customer should have access to preview features. | — | ||||||||||
isMfaRequired
|
boolean
|
— | Indicates if users in the organization are required to enroll and use multi-factor authentication | — | ||||||||||
isSelfService
|
boolean
|
— | Indicates this organization was created as part of a self-service product onboarding or demonstration flow. | — | ||||||||||
technicalContact
|
string
|
nullable |
The technical contact information for the organization.
maxLength: 250
|
— |
Example
{
"name": "Welcome Woods Inc.",
"type": "string",
"contact": "string",
"displayName": "Welcome Woods Inc.",
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"technicalContact": "string",
"isEnabledForPreviewFeatures": false
}Schema
| Name | Type | Attributes | Description | Extensions | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
crmAccountId
|
string
|
required |
The CRM account identifier.
minLength: 1 · maxLength: 250
|
— | ||||||||||
displayName
|
string
|
required |
Name of the organization
minLength: 1 · maxLength: 250
|
— | ||||||||||
name
|
string
|
required |
Name of the organization
minLength: 1 · maxLength: 250
|
— | ||||||||||
type
|
OrganizationType
|
required |
Defines a list of valid organization types.
|
— | ||||||||||
contact
|
string
|
nullable |
The general contact information for the organization.
maxLength: 250
|
— | ||||||||||
isEnabledForPreviewFeatures
|
boolean
|
— | This flag has no defined purpose in Nexus and is used by applications to determine if a customer should have access to preview features. | — | ||||||||||
isMfaRequired
|
boolean
|
— | Indicates if users in the organization are required to enroll and use multi-factor authentication | — | ||||||||||
isSelfService
|
boolean
|
— | Indicates this organization was created as part of a self-service product onboarding or demonstration flow. | — | ||||||||||
technicalContact
|
string
|
nullable |
The technical contact information for the organization.
maxLength: 250
|
— |
Responses
201
Example
{
"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": {
"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"
}
],
"isActive": false,
"modified": "string",
"products": [
{
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"product": null,
"metadata": null,
"organization": null,
"publicMetadata": null
}
],
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"subscriptions": [
{
"status": null,
"product": null,
"organization": null,
"customMetadata": null,
"readonlyMetadata": null
}
],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
}
],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"id": 0,
"name": "string",
"created": "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"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"details": null,
"application": null
}
],
"userDefaultIsActive": false
}
],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": 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",
"sfLicenseId": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"sfContractId": "string",
"customMetadata": {},
"organizationId": 0,
"readonlyMetadata": {},
"sfSubscriptionId": "string",
"applicationDeployments": [
{
"application": null,
"subscription": null,
"customMetadata": null,
"deploymentTarget": null,
"readonlyMetadata": null
}
]
}
],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
}Schema
| Name | Type | Attributes | Description | Extensions | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
aliases
|
nullable | The list of aliases | — | |||||||||||
applications
|
nullable | The list of applications | — | |||||||||||
contact
|
string
|
nullable | The general contact information for the organization. | — | ||||||||||
created
|
string (date-time)
|
nullable | The date/time the record was created (UTC). | — | ||||||||||
createdBy
|
string
|
nullable | The user or user that created the record. | — | ||||||||||
crmAccountId
|
string
|
nullable | The CRM account identifier. | — | ||||||||||
displayName
|
string
|
nullable | A human readable unique name | — | ||||||||||
domains
|
nullable | List of domain names associated with the organization | — | |||||||||||
id
|
integer (int32)
|
nullable | A system assigned unique identifier. | — | ||||||||||
isActive
|
boolean
|
— | Indicates if the organization is active | — | ||||||||||
isDomainVerificationRequired
|
boolean
|
nullable | WARNING this should almost never be used and has far reaching and unknown consequences. This disabled verification of domains when user accounts are created. | — | ||||||||||
isEnabledForPreviewFeatures
|
boolean
|
nullable | This flag has no defined purpose in Nexus and is used by applications to determine if a customer should have access to preview features. | — | ||||||||||
isMfaRequired
|
boolean
|
— | Indicates if users in the organization are required to enroll and use multi-factor authentication. This is only applicable if the user's Nexus.Backend.Domain.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. <b>WARNING!</b> This value takes effect immediately. | — | ||||||||||
isSelfService
|
boolean
|
— | Indicates this organization was created as part of a self-service product onboarding or demonstration flow. | — | ||||||||||
members
|
nullable | List of member users | — | |||||||||||
modified
|
string (date-time)
|
nullable | The date/time the record was last modified (UTC). | — | ||||||||||
modifiedBy
|
string
|
nullable | The user or user that last modified the record. | — | ||||||||||
name
|
string
|
nullable | A human readable unique name | — | ||||||||||
products
|
nullable | The list of products | — | |||||||||||
subscriptions
|
nullable | List of orders | — | |||||||||||
technicalContact
|
string
|
nullable | The technical contact information for the organization. | — | ||||||||||
type
|
OrganizationType
|
— |
Defines a list of valid organization types.
|
— |
Example
{
"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": {
"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"
}
],
"isActive": false,
"modified": "string",
"products": [
{
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"product": null,
"metadata": null,
"organization": null,
"publicMetadata": null
}
],
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"subscriptions": [
{
"status": null,
"product": null,
"organization": null,
"customMetadata": null,
"readonlyMetadata": null
}
],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
}
],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"id": 0,
"name": "string",
"created": "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"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"details": null,
"application": null
}
],
"userDefaultIsActive": false
}
],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": 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",
"sfLicenseId": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"sfContractId": "string",
"customMetadata": {},
"organizationId": 0,
"readonlyMetadata": {},
"sfSubscriptionId": "string",
"applicationDeployments": [
{
"application": null,
"subscription": null,
"customMetadata": null,
"deploymentTarget": null,
"readonlyMetadata": null
}
]
}
],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
}Schema
| Name | Type | Attributes | Description | Extensions | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
aliases
|
nullable | The list of aliases | — | |||||||||||
applications
|
nullable | The list of applications | — | |||||||||||
contact
|
string
|
nullable | The general contact information for the organization. | — | ||||||||||
created
|
string (date-time)
|
nullable | The date/time the record was created (UTC). | — | ||||||||||
createdBy
|
string
|
nullable | The user or user that created the record. | — | ||||||||||
crmAccountId
|
string
|
nullable | The CRM account identifier. | — | ||||||||||
displayName
|
string
|
nullable | A human readable unique name | — | ||||||||||
domains
|
nullable | List of domain names associated with the organization | — | |||||||||||
id
|
integer (int32)
|
nullable | A system assigned unique identifier. | — | ||||||||||
isActive
|
boolean
|
— | Indicates if the organization is active | — | ||||||||||
isDomainVerificationRequired
|
boolean
|
nullable | WARNING this should almost never be used and has far reaching and unknown consequences. This disabled verification of domains when user accounts are created. | — | ||||||||||
isEnabledForPreviewFeatures
|
boolean
|
nullable | This flag has no defined purpose in Nexus and is used by applications to determine if a customer should have access to preview features. | — | ||||||||||
isMfaRequired
|
boolean
|
— | Indicates if users in the organization are required to enroll and use multi-factor authentication. This is only applicable if the user's Nexus.Backend.Domain.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. <b>WARNING!</b> This value takes effect immediately. | — | ||||||||||
isSelfService
|
boolean
|
— | Indicates this organization was created as part of a self-service product onboarding or demonstration flow. | — | ||||||||||
members
|
nullable | List of member users | — | |||||||||||
modified
|
string (date-time)
|
nullable | The date/time the record was last modified (UTC). | — | ||||||||||
modifiedBy
|
string
|
nullable | The user or user that last modified the record. | — | ||||||||||
name
|
string
|
nullable | A human readable unique name | — | ||||||||||
products
|
nullable | The list of products | — | |||||||||||
subscriptions
|
nullable | List of orders | — | |||||||||||
technicalContact
|
string
|
nullable | The technical contact information for the organization. | — | ||||||||||
type
|
OrganizationType
|
— |
Defines a list of valid organization types.
|
— |
Example
{
"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": {
"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"
}
],
"isActive": false,
"modified": "string",
"products": [
{
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"product": null,
"metadata": null,
"organization": null,
"publicMetadata": null
}
],
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"subscriptions": [
{
"status": null,
"product": null,
"organization": null,
"customMetadata": null,
"readonlyMetadata": null
}
],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
}
],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"id": 0,
"name": "string",
"created": "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"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"details": null,
"application": null
}
],
"userDefaultIsActive": false
}
],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": 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",
"sfLicenseId": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"sfContractId": "string",
"customMetadata": {},
"organizationId": 0,
"readonlyMetadata": {},
"sfSubscriptionId": "string",
"applicationDeployments": [
{
"application": null,
"subscription": null,
"customMetadata": null,
"deploymentTarget": null,
"readonlyMetadata": null
}
]
}
],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
}Schema
| Name | Type | Attributes | Description | Extensions | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
aliases
|
nullable | The list of aliases | — | |||||||||||
applications
|
nullable | The list of applications | — | |||||||||||
contact
|
string
|
nullable | The general contact information for the organization. | — | ||||||||||
created
|
string (date-time)
|
nullable | The date/time the record was created (UTC). | — | ||||||||||
createdBy
|
string
|
nullable | The user or user that created the record. | — | ||||||||||
crmAccountId
|
string
|
nullable | The CRM account identifier. | — | ||||||||||
displayName
|
string
|
nullable | A human readable unique name | — | ||||||||||
domains
|
nullable | List of domain names associated with the organization | — | |||||||||||
id
|
integer (int32)
|
nullable | A system assigned unique identifier. | — | ||||||||||
isActive
|
boolean
|
— | Indicates if the organization is active | — | ||||||||||
isDomainVerificationRequired
|
boolean
|
nullable | WARNING this should almost never be used and has far reaching and unknown consequences. This disabled verification of domains when user accounts are created. | — | ||||||||||
isEnabledForPreviewFeatures
|
boolean
|
nullable | This flag has no defined purpose in Nexus and is used by applications to determine if a customer should have access to preview features. | — | ||||||||||
isMfaRequired
|
boolean
|
— | Indicates if users in the organization are required to enroll and use multi-factor authentication. This is only applicable if the user's Nexus.Backend.Domain.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. <b>WARNING!</b> This value takes effect immediately. | — | ||||||||||
isSelfService
|
boolean
|
— | Indicates this organization was created as part of a self-service product onboarding or demonstration flow. | — | ||||||||||
members
|
nullable | List of member users | — | |||||||||||
modified
|
string (date-time)
|
nullable | The date/time the record was last modified (UTC). | — | ||||||||||
modifiedBy
|
string
|
nullable | The user or user that last modified the record. | — | ||||||||||
name
|
string
|
nullable | A human readable unique name | — | ||||||||||
products
|
nullable | The list of products | — | |||||||||||
subscriptions
|
nullable | List of orders | — | |||||||||||
technicalContact
|
string
|
nullable | The technical contact information for the organization. | — | ||||||||||
type
|
OrganizationType
|
— |
Defines a list of valid organization types.
|
— |
Example
{
"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": {
"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"
}
],
"isActive": false,
"modified": "string",
"products": [
{
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"product": null,
"metadata": null,
"organization": null,
"publicMetadata": null
}
],
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"subscriptions": [
{
"status": null,
"product": null,
"organization": null,
"customMetadata": null,
"readonlyMetadata": null
}
],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
}
],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"id": 0,
"name": "string",
"created": "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"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"details": null,
"application": null
}
],
"userDefaultIsActive": false
}
],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": 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",
"sfLicenseId": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"sfContractId": "string",
"customMetadata": {},
"organizationId": 0,
"readonlyMetadata": {},
"sfSubscriptionId": "string",
"applicationDeployments": [
{
"application": null,
"subscription": null,
"customMetadata": null,
"deploymentTarget": null,
"readonlyMetadata": null
}
]
}
],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
}Schema
| Name | Type | Attributes | Description | Extensions | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
aliases
|
nullable | The list of aliases | — | |||||||||||
applications
|
nullable | The list of applications | — | |||||||||||
contact
|
string
|
nullable | The general contact information for the organization. | — | ||||||||||
created
|
string (date-time)
|
nullable | The date/time the record was created (UTC). | — | ||||||||||
createdBy
|
string
|
nullable | The user or user that created the record. | — | ||||||||||
crmAccountId
|
string
|
nullable | The CRM account identifier. | — | ||||||||||
displayName
|
string
|
nullable | A human readable unique name | — | ||||||||||
domains
|
nullable | List of domain names associated with the organization | — | |||||||||||
id
|
integer (int32)
|
nullable | A system assigned unique identifier. | — | ||||||||||
isActive
|
boolean
|
— | Indicates if the organization is active | — | ||||||||||
isDomainVerificationRequired
|
boolean
|
nullable | WARNING this should almost never be used and has far reaching and unknown consequences. This disabled verification of domains when user accounts are created. | — | ||||||||||
isEnabledForPreviewFeatures
|
boolean
|
nullable | This flag has no defined purpose in Nexus and is used by applications to determine if a customer should have access to preview features. | — | ||||||||||
isMfaRequired
|
boolean
|
— | Indicates if users in the organization are required to enroll and use multi-factor authentication. This is only applicable if the user's Nexus.Backend.Domain.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. <b>WARNING!</b> This value takes effect immediately. | — | ||||||||||
isSelfService
|
boolean
|
— | Indicates this organization was created as part of a self-service product onboarding or demonstration flow. | — | ||||||||||
members
|
nullable | List of member users | — | |||||||||||
modified
|
string (date-time)
|
nullable | The date/time the record was last modified (UTC). | — | ||||||||||
modifiedBy
|
string
|
nullable | The user or user that last modified the record. | — | ||||||||||
name
|
string
|
nullable | A human readable unique name | — | ||||||||||
products
|
nullable | The list of products | — | |||||||||||
subscriptions
|
nullable | List of orders | — | |||||||||||
technicalContact
|
string
|
nullable | The technical contact information for the organization. | — | ||||||||||
type
|
OrganizationType
|
— |
Defines a list of valid organization types.
|
— |
Example
{
"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": {
"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"
}
],
"isActive": false,
"modified": "string",
"products": [
{
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"product": null,
"metadata": null,
"organization": null,
"publicMetadata": null
}
],
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"subscriptions": [
{
"status": null,
"product": null,
"organization": null,
"customMetadata": null,
"readonlyMetadata": null
}
],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
}
],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"id": 0,
"name": "string",
"created": "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"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"details": null,
"application": null
}
],
"userDefaultIsActive": false
}
],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": 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",
"sfLicenseId": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"sfContractId": "string",
"customMetadata": {},
"organizationId": 0,
"readonlyMetadata": {},
"sfSubscriptionId": "string",
"applicationDeployments": [
{
"application": null,
"subscription": null,
"customMetadata": null,
"deploymentTarget": null,
"readonlyMetadata": null
}
]
}
],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
}Schema
| Name | Type | Attributes | Description | Extensions | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
aliases
|
nullable | The list of aliases | — | |||||||||||
applications
|
nullable | The list of applications | — | |||||||||||
contact
|
string
|
nullable | The general contact information for the organization. | — | ||||||||||
created
|
string (date-time)
|
nullable | The date/time the record was created (UTC). | — | ||||||||||
createdBy
|
string
|
nullable | The user or user that created the record. | — | ||||||||||
crmAccountId
|
string
|
nullable | The CRM account identifier. | — | ||||||||||
displayName
|
string
|
nullable | A human readable unique name | — | ||||||||||
domains
|
nullable | List of domain names associated with the organization | — | |||||||||||
id
|
integer (int32)
|
nullable | A system assigned unique identifier. | — | ||||||||||
isActive
|
boolean
|
— | Indicates if the organization is active | — | ||||||||||
isDomainVerificationRequired
|
boolean
|
nullable | WARNING this should almost never be used and has far reaching and unknown consequences. This disabled verification of domains when user accounts are created. | — | ||||||||||
isEnabledForPreviewFeatures
|
boolean
|
nullable | This flag has no defined purpose in Nexus and is used by applications to determine if a customer should have access to preview features. | — | ||||||||||
isMfaRequired
|
boolean
|
— | Indicates if users in the organization are required to enroll and use multi-factor authentication. This is only applicable if the user's Nexus.Backend.Domain.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. <b>WARNING!</b> This value takes effect immediately. | — | ||||||||||
isSelfService
|
boolean
|
— | Indicates this organization was created as part of a self-service product onboarding or demonstration flow. | — | ||||||||||
members
|
nullable | List of member users | — | |||||||||||
modified
|
string (date-time)
|
nullable | The date/time the record was last modified (UTC). | — | ||||||||||
modifiedBy
|
string
|
nullable | The user or user that last modified the record. | — | ||||||||||
name
|
string
|
nullable | A human readable unique name | — | ||||||||||
products
|
nullable | The list of products | — | |||||||||||
subscriptions
|
nullable | List of orders | — | |||||||||||
technicalContact
|
string
|
nullable | The technical contact information for the organization. | — | ||||||||||
type
|
OrganizationType
|
— |
Defines a list of valid organization types.
|
— |
Example
{
"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": {
"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"
}
],
"isActive": false,
"modified": "string",
"products": [
{
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"product": null,
"metadata": null,
"organization": null,
"publicMetadata": null
}
],
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"subscriptions": [
{
"status": null,
"product": null,
"organization": null,
"customMetadata": null,
"readonlyMetadata": null
}
],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
}
],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"id": 0,
"name": "string",
"created": "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"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"details": null,
"application": null
}
],
"userDefaultIsActive": false
}
],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": 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",
"sfLicenseId": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"sfContractId": "string",
"customMetadata": {},
"organizationId": 0,
"readonlyMetadata": {},
"sfSubscriptionId": "string",
"applicationDeployments": [
{
"application": null,
"subscription": null,
"customMetadata": null,
"deploymentTarget": null,
"readonlyMetadata": null
}
]
}
],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
}Schema
| Name | Type | Attributes | Description | Extensions | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
aliases
|
nullable | The list of aliases | — | |||||||||||
applications
|
nullable | The list of applications | — | |||||||||||
contact
|
string
|
nullable | The general contact information for the organization. | — | ||||||||||
created
|
string (date-time)
|
nullable | The date/time the record was created (UTC). | — | ||||||||||
createdBy
|
string
|
nullable | The user or user that created the record. | — | ||||||||||
crmAccountId
|
string
|
nullable | The CRM account identifier. | — | ||||||||||
displayName
|
string
|
nullable | A human readable unique name | — | ||||||||||
domains
|
nullable | List of domain names associated with the organization | — | |||||||||||
id
|
integer (int32)
|
nullable | A system assigned unique identifier. | — | ||||||||||
isActive
|
boolean
|
— | Indicates if the organization is active | — | ||||||||||
isDomainVerificationRequired
|
boolean
|
nullable | WARNING this should almost never be used and has far reaching and unknown consequences. This disabled verification of domains when user accounts are created. | — | ||||||||||
isEnabledForPreviewFeatures
|
boolean
|
nullable | This flag has no defined purpose in Nexus and is used by applications to determine if a customer should have access to preview features. | — | ||||||||||
isMfaRequired
|
boolean
|
— | Indicates if users in the organization are required to enroll and use multi-factor authentication. This is only applicable if the user's Nexus.Backend.Domain.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. <b>WARNING!</b> This value takes effect immediately. | — | ||||||||||
isSelfService
|
boolean
|
— | Indicates this organization was created as part of a self-service product onboarding or demonstration flow. | — | ||||||||||
members
|
nullable | List of member users | — | |||||||||||
modified
|
string (date-time)
|
nullable | The date/time the record was last modified (UTC). | — | ||||||||||
modifiedBy
|
string
|
nullable | The user or user that last modified the record. | — | ||||||||||
name
|
string
|
nullable | A human readable unique name | — | ||||||||||
products
|
nullable | The list of products | — | |||||||||||
subscriptions
|
nullable | List of orders | — | |||||||||||
technicalContact
|
string
|
nullable | The technical contact information for the organization. | — | ||||||||||
type
|
OrganizationType
|
— |
Defines a list of valid organization types.
|
— |
Example
{
"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": {
"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"
}
],
"isActive": false,
"modified": "string",
"products": [
{
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"product": null,
"metadata": null,
"organization": null,
"publicMetadata": null
}
],
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"subscriptions": [
{
"status": null,
"product": null,
"organization": null,
"customMetadata": null,
"readonlyMetadata": null
}
],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
}
],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"id": 0,
"name": "string",
"created": "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"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"details": null,
"application": null
}
],
"userDefaultIsActive": false
}
],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": 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",
"sfLicenseId": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"sfContractId": "string",
"customMetadata": {},
"organizationId": 0,
"readonlyMetadata": {},
"sfSubscriptionId": "string",
"applicationDeployments": [
{
"application": null,
"subscription": null,
"customMetadata": null,
"deploymentTarget": null,
"readonlyMetadata": null
}
]
}
],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
}Schema
| Name | Type | Attributes | Description | Extensions | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
aliases
|
nullable | The list of aliases | — | |||||||||||
applications
|
nullable | The list of applications | — | |||||||||||
contact
|
string
|
nullable | The general contact information for the organization. | — | ||||||||||
created
|
string (date-time)
|
nullable | The date/time the record was created (UTC). | — | ||||||||||
createdBy
|
string
|
nullable | The user or user that created the record. | — | ||||||||||
crmAccountId
|
string
|
nullable | The CRM account identifier. | — | ||||||||||
displayName
|
string
|
nullable | A human readable unique name | — | ||||||||||
domains
|
nullable | List of domain names associated with the organization | — | |||||||||||
id
|
integer (int32)
|
nullable | A system assigned unique identifier. | — | ||||||||||
isActive
|
boolean
|
— | Indicates if the organization is active | — | ||||||||||
isDomainVerificationRequired
|
boolean
|
nullable | WARNING this should almost never be used and has far reaching and unknown consequences. This disabled verification of domains when user accounts are created. | — | ||||||||||
isEnabledForPreviewFeatures
|
boolean
|
nullable | This flag has no defined purpose in Nexus and is used by applications to determine if a customer should have access to preview features. | — | ||||||||||
isMfaRequired
|
boolean
|
— | Indicates if users in the organization are required to enroll and use multi-factor authentication. This is only applicable if the user's Nexus.Backend.Domain.AuthenticationMethod is Nexus.Backend.Domain.AuthenticationMethod.Database or Nexus.Backend.Domain.AuthenticationMethod.Ad. <b>WARNING!</b> This value takes effect immediately. | — | ||||||||||
isSelfService
|
boolean
|
— | Indicates this organization was created as part of a self-service product onboarding or demonstration flow. | — | ||||||||||
members
|
nullable | List of member users | — | |||||||||||
modified
|
string (date-time)
|
nullable | The date/time the record was last modified (UTC). | — | ||||||||||
modifiedBy
|
string
|
nullable | The user or user that last modified the record. | — | ||||||||||
name
|
string
|
nullable | A human readable unique name | — | ||||||||||
products
|
nullable | The list of products | — | |||||||||||
subscriptions
|
nullable | List of orders | — | |||||||||||
technicalContact
|
string
|
nullable | The technical contact information for the organization. | — | ||||||||||
type
|
OrganizationType
|
— |
Defines a list of valid organization types.
|
— |
Security
Authentication is required for this operation.
Source: default
Requirements (any one option may satisfy)
- Bearer and ApplicationToken
- Basic