[{"label":"Latest (v1)","version":"latest"}]

cloud-partner-navigator

InlineOrg1

Properties

boolean

isFederated Required

The flag to identify the federated users.

boolean

optOut Required

The flag to mark property opyOut.

array of string

additionalMasterOrgIds Optional

The list of additional master organizations in the provider organization.

string as binary

adminUserEmail Optional

The admin user email of the organization.

string as binary

adminUserName Optional

The admin user name in the organization.

array of string

aggregateContractIds Optional

The list of aggregate contract ids in the organization.

Contact

alternatePrimaryContact Optional

Defines the properties of the Contact.

array of Contact

alternatePrimaryContacts Optional

The list of alternate primary contacts.

array of string

childOrgIds Optional

The list of child organizations in the master organization.

string as binary

city Optional

The city of the organization.

string

companyName Optional

The company name of the user in the organization.

ConfigurationStatus

configStatus Optional

Defines the properties of the Configuration Status.

string as binary

country Optional

The country of the user in the organization.

string

createdByUserId Optional

Create the org bu user id.

array of Currency

currencies Optional

The list of the supported currencies.

string

description Optional

The description of the organization.

string

displayName Optional

The display name of the organization.

string

domain Optional

The domain name in the organization.

string

id Optional

The id of the organization.

string

addressLine2 Optional

The address line of the customer in the organization.

map of string

metaData Optional

The meta data of the organization.

string

name Optional

The name of the user in the organization.

array of OrgNature Enum

natures Optional

Defines the properties of the Org nature.

Possible values are: ALL_NATURE , MSP , PARTNER , OPS_STOP , DISTRIBUTOR

string

addressLine1 Optional

The address of the user in the organization.

OrgType Enum

orgType Optional

Defines the properties of the Org type.

Possible values are: OPERATOR , PROVIDER , TENANT

string

parentOrgId Optional

The parent organization id of the provider org.

array of PartnerType Enum

partnerTypes Optional

Defines the properties of the Partner type.

Possible values are: PARTNER , RESELLER , DIRECT_RESELLER , OEM

string as binary

phone Optional

The phone number of the user in the organization.

Contact

primaryContact Optional

Defines the properties of the Contact.

array of Contact

primaryContacts Optional

The primary contact of the user in the organization.

ProviderStatus Enum

providerStatus Optional

Defines the properties of the Provider status.

Possible values are: TRIAL , PAID

ProviderType Enum

providerType Optional

Defines the properties of the Provider type..

Possible values are: STANDARD , ADDITIONAL

OrgRealm Enum

realm Optional

Defines the properties of the org realm.

Possible values are: CPHUB , CPATH

Seller Enum

seller Optional

Defines the properties of the seller, the values can be - VMWARE, AWS etc

Possible values are: VMWARE , AWS

string

spPrmId Optional

The spprm id of the organization.

string as binary

state Optional

The state the user belongs to in the organization.

Status

status Optional

Defines the properties of the Status.

Possible values are: ACTIVE , DISABLED

string

tag Optional

The tag in the organization.

TenantType Enum

tenantType Optional

Defines the properties of the Tenant type.

Possible values are: INTENRAL , DEFAULT

string

updatedByUserId Optional

Update the organization details using user id.

string as binary

website Optional

The website details in the organization.

string as binary

zip Optional

The zip code of the organization.

JSON Example

Show optional properties

{
    "isFederated": true,
    "optOut": true
}

{
    "additionalMasterOrgIds": [
        "...",
        "..."
    ],
    "addressLine1": "...",
    "addressLine2": "...",
    "adminUserEmail": {},
    "adminUserName": {},
    "aggregateContractIds": [
        "...",
        "..."
    ],
    "alternatePrimaryContact": {
        "email": "...",
        "username": "..."
    },
    "alternatePrimaryContacts": [
        {
            "email": "...",
            "username": "..."
        },
        {
            "email": "...",
            "username": "..."
        }
    ],
    "childOrgIds": [
        "...",
        "..."
    ],
    "city": {},
    "companyName": "...",
    "configStatus": {
        "configResults": [
            {
                "message": "...",
                "state": "DEACTIVATING_MSP_TENANT"
            },
            {
                "message": "...",
                "state": "MSP_SERVICE_UNGATING_ERROR"
            }
        ],
        "configState": "SUCCESS",
        "createTimestamp": 12345,
        "updateTimestamp": 12345
    },
    "country": {},
    "createTimestamp": 12345,
    "createdByUserId": "...",
    "currencies": [
        {
            "default": true,
            "isDefault": true,
            "name": "..."
        },
        {
            "default": true,
            "isDefault": true,
            "name": "..."
        }
    ],
    "description": "...",
    "displayName": "...",
    "domain": "...",
    "id": "...",
    "isFederated": true,
    "metaData": {
        "property1": "...",
        "property2": "..."
    },
    "name": "...",
    "natures": [
        "DISTRIBUTOR",
        "PARTNER"
    ],
    "optOut": true,
    "orgType": "PROVIDER",
    "parentOrgId": "...",
    "partnerTypes": [
        "RESELLER",
        "DIRECT_RESELLER"
    ],
    "phone": {},
    "primaryContact": {
        "email": "...",
        "username": "..."
    },
    "primaryContacts": [
        {
            "email": "...",
            "username": "..."
        },
        {
            "email": "...",
            "username": "..."
        }
    ],
    "providerStatus": "TRIAL",
    "providerType": "ADDITIONAL",
    "realm": "CPHUB",
    "seller": "VMWARE",
    "spPrmId": "...",
    "state": {},
    "status": "ACTIVE",
    "tag": "...",
    "tenantType": "DEFAULT",
    "updateTimestamp": 12345,
    "updatedByUserId": "...",
    "website": {},
    "zip": {}
}

[{"label":"Latest (v1)","version":"latest"}]

cloud-partner-navigator

Used By

Org

InlineOrg1

Properties

JSON Example

Used By

Was this page helpful?