Nexus
Nexus APIs
POST
/v1/applications
Registers an application
Requires the application.write permission
Request body
Request payload
Example
{
"name": "string",
"isActive": false,
"metadata": {},
"productId": 0,
"displayName": "string",
"organizationId": 0,
"publicMetadata": {}
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
displayName
|
string
|
nullable | Display Name | — |
isActive
|
boolean
|
— | Is Active | — |
metadata
|
— | JsonObject primitive | — | |
name
|
string
|
nullable | Name | — |
organizationId
|
integer (int32)
|
— | Id of the owning division | — |
productId
|
integer (int32)
|
nullable | Id of the owning product, optional | — |
publicMetadata
|
— | JsonObject primitive | — |
Example
{
"name": "string",
"isActive": false,
"metadata": {},
"productId": 0,
"displayName": "string",
"organizationId": 0,
"publicMetadata": {}
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
displayName
|
string
|
nullable | Display Name | — |
isActive
|
boolean
|
— | Is Active | — |
metadata
|
— | JsonObject primitive | — | |
name
|
string
|
nullable | Name | — |
organizationId
|
integer (int32)
|
— | Id of the owning division | — |
productId
|
integer (int32)
|
nullable | Id of the owning product, optional | — |
publicMetadata
|
— | JsonObject primitive | — |
Example
{
"name": "string",
"isActive": false,
"metadata": {},
"productId": 0,
"displayName": "string",
"organizationId": 0,
"publicMetadata": {}
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
displayName
|
string
|
nullable | Display Name | — |
isActive
|
boolean
|
— | Is Active | — |
metadata
|
— | JsonObject primitive | — | |
name
|
string
|
nullable | Name | — |
organizationId
|
integer (int32)
|
— | Id of the owning division | — |
productId
|
integer (int32)
|
nullable | Id of the owning product, optional | — |
publicMetadata
|
— | JsonObject primitive | — |
Example
{
"name": "string",
"isActive": false,
"metadata": {},
"productId": 0,
"displayName": "string",
"organizationId": 0,
"publicMetadata": {}
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
displayName
|
string
|
nullable | Display Name | — |
isActive
|
boolean
|
— | Is Active | — |
metadata
|
— | JsonObject primitive | — | |
name
|
string
|
nullable | Name | — |
organizationId
|
integer (int32)
|
— | Id of the owning division | — |
productId
|
integer (int32)
|
nullable | Id of the owning product, optional | — |
publicMetadata
|
— | JsonObject primitive | — |
Example
{
"name": "string",
"isActive": false,
"metadata": {},
"productId": 0,
"displayName": "string",
"organizationId": 0,
"publicMetadata": {}
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
displayName
|
string
|
nullable | Display Name | — |
isActive
|
boolean
|
— | Is Active | — |
metadata
|
— | JsonObject primitive | — | |
name
|
string
|
nullable | Name | — |
organizationId
|
integer (int32)
|
— | Id of the owning division | — |
productId
|
integer (int32)
|
nullable | Id of the owning product, optional | — |
publicMetadata
|
— | JsonObject primitive | — |
Example
{
"name": "string",
"isActive": false,
"metadata": {},
"productId": 0,
"displayName": "string",
"organizationId": 0,
"publicMetadata": {}
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
displayName
|
string
|
nullable | Display Name | — |
isActive
|
boolean
|
— | Is Active | — |
metadata
|
— | JsonObject primitive | — | |
name
|
string
|
nullable | Name | — |
organizationId
|
integer (int32)
|
— | Id of the owning division | — |
productId
|
integer (int32)
|
nullable | Id of the owning product, optional | — |
publicMetadata
|
— | JsonObject primitive | — |
Example
{
"name": "string",
"isActive": false,
"metadata": {},
"productId": 0,
"displayName": "string",
"organizationId": 0,
"publicMetadata": {}
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
displayName
|
string
|
nullable | Display Name | — |
isActive
|
boolean
|
— | Is Active | — |
metadata
|
— | JsonObject primitive | — | |
name
|
string
|
nullable | Name | — |
organizationId
|
integer (int32)
|
— | Id of the owning division | — |
productId
|
integer (int32)
|
nullable | Id of the owning product, optional | — |
publicMetadata
|
— | JsonObject primitive | — |
Example
{
"name": "string",
"isActive": false,
"metadata": {},
"productId": 0,
"displayName": "string",
"organizationId": 0,
"publicMetadata": {}
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
displayName
|
string
|
nullable | Display Name | — |
isActive
|
boolean
|
— | Is Active | — |
metadata
|
— | JsonObject primitive | — | |
name
|
string
|
nullable | Name | — |
organizationId
|
integer (int32)
|
— | Id of the owning division | — |
productId
|
integer (int32)
|
nullable | Id of the owning product, optional | — |
publicMetadata
|
— | JsonObject primitive | — |
Responses
201
Example
{
"id": 0,
"name": "string",
"created": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"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
}
],
"organization": {
"id": 0,
"name": "string",
"type": "string",
"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": [
{
"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",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"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",
"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",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": {},
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "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
},
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}
],
"userDefaultIsActive": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
deploymentTargets
|
nullable | — | — | |
displayName
|
string
|
nullable | — | — |
id
|
integer (int32)
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
metadata
|
— | JsonObject primitive | — | |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
name
|
string
|
nullable | — | — |
organization
|
— | Represents an Organization | — | |
organizationId
|
integer (int32)
|
nullable | — | — |
product
|
— | Represents metadata available about a Product. | — | |
productId
|
integer (int32)
|
nullable | — | — |
publicMetadata
|
— | JsonObject primitive | — | |
userDefaultIsActive
|
boolean
|
nullable | — | — |
Example
{
"id": 0,
"name": "string",
"created": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"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
}
],
"organization": {
"id": 0,
"name": "string",
"type": "string",
"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": [
{
"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",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"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",
"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",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": {},
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "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
},
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}
],
"userDefaultIsActive": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
deploymentTargets
|
nullable | — | — | |
displayName
|
string
|
nullable | — | — |
id
|
integer (int32)
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
metadata
|
— | JsonObject primitive | — | |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
name
|
string
|
nullable | — | — |
organization
|
— | Represents an Organization | — | |
organizationId
|
integer (int32)
|
nullable | — | — |
product
|
— | Represents metadata available about a Product. | — | |
productId
|
integer (int32)
|
nullable | — | — |
publicMetadata
|
— | JsonObject primitive | — | |
userDefaultIsActive
|
boolean
|
nullable | — | — |
Example
{
"id": 0,
"name": "string",
"created": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"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
}
],
"organization": {
"id": 0,
"name": "string",
"type": "string",
"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": [
{
"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",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"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",
"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",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": {},
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "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
},
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}
],
"userDefaultIsActive": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
deploymentTargets
|
nullable | — | — | |
displayName
|
string
|
nullable | — | — |
id
|
integer (int32)
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
metadata
|
— | JsonObject primitive | — | |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
name
|
string
|
nullable | — | — |
organization
|
— | Represents an Organization | — | |
organizationId
|
integer (int32)
|
nullable | — | — |
product
|
— | Represents metadata available about a Product. | — | |
productId
|
integer (int32)
|
nullable | — | — |
publicMetadata
|
— | JsonObject primitive | — | |
userDefaultIsActive
|
boolean
|
nullable | — | — |
Example
{
"id": 0,
"name": "string",
"created": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"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
}
],
"organization": {
"id": 0,
"name": "string",
"type": "string",
"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": [
{
"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",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"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",
"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",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": {},
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "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
},
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}
],
"userDefaultIsActive": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
deploymentTargets
|
nullable | — | — | |
displayName
|
string
|
nullable | — | — |
id
|
integer (int32)
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
metadata
|
— | JsonObject primitive | — | |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
name
|
string
|
nullable | — | — |
organization
|
— | Represents an Organization | — | |
organizationId
|
integer (int32)
|
nullable | — | — |
product
|
— | Represents metadata available about a Product. | — | |
productId
|
integer (int32)
|
nullable | — | — |
publicMetadata
|
— | JsonObject primitive | — | |
userDefaultIsActive
|
boolean
|
nullable | — | — |
Example
{
"id": 0,
"name": "string",
"created": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"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
}
],
"organization": {
"id": 0,
"name": "string",
"type": "string",
"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": [
{
"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",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"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",
"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",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": {},
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "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
},
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}
],
"userDefaultIsActive": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
deploymentTargets
|
nullable | — | — | |
displayName
|
string
|
nullable | — | — |
id
|
integer (int32)
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
metadata
|
— | JsonObject primitive | — | |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
name
|
string
|
nullable | — | — |
organization
|
— | Represents an Organization | — | |
organizationId
|
integer (int32)
|
nullable | — | — |
product
|
— | Represents metadata available about a Product. | — | |
productId
|
integer (int32)
|
nullable | — | — |
publicMetadata
|
— | JsonObject primitive | — | |
userDefaultIsActive
|
boolean
|
nullable | — | — |
Example
{
"id": 0,
"name": "string",
"created": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"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
}
],
"organization": {
"id": 0,
"name": "string",
"type": "string",
"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": [
{
"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",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"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",
"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",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": {},
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "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
},
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}
],
"userDefaultIsActive": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
deploymentTargets
|
nullable | — | — | |
displayName
|
string
|
nullable | — | — |
id
|
integer (int32)
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
metadata
|
— | JsonObject primitive | — | |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
name
|
string
|
nullable | — | — |
organization
|
— | Represents an Organization | — | |
organizationId
|
integer (int32)
|
nullable | — | — |
product
|
— | Represents metadata available about a Product. | — | |
productId
|
integer (int32)
|
nullable | — | — |
publicMetadata
|
— | JsonObject primitive | — | |
userDefaultIsActive
|
boolean
|
nullable | — | — |
Example
{
"id": 0,
"name": "string",
"created": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"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
}
],
"organization": {
"id": 0,
"name": "string",
"type": "string",
"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": [
{
"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",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"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",
"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",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": {},
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "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
},
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}
],
"userDefaultIsActive": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
deploymentTargets
|
nullable | — | — | |
displayName
|
string
|
nullable | — | — |
id
|
integer (int32)
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
metadata
|
— | JsonObject primitive | — | |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
name
|
string
|
nullable | — | — |
organization
|
— | Represents an Organization | — | |
organizationId
|
integer (int32)
|
nullable | — | — |
product
|
— | Represents metadata available about a Product. | — | |
productId
|
integer (int32)
|
nullable | — | — |
publicMetadata
|
— | JsonObject primitive | — | |
userDefaultIsActive
|
boolean
|
nullable | — | — |
Security
Authentication is required for this operation.
Source: default
Requirements (any one option may satisfy)
- Bearer and ApplicationToken
- Basic