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

cloud-partner-navigator

Enable Service

Description

Enables a specified service for a specified organization.

Request

URL

patch

https://console.navigator.vmware.com/cphub/api/core/v1/mgmt/orgs/{orgId}/services/{serviceDefinitionId}

Copy

Path Parameters

string

orgId Required

ID of the MSP organization in CSP.

Parameter Serialization Style: simple

string

serviceDefinitionId Required

ID of the service definition in a MSP organization.

Parameter Serialization Style: simple

Header Parameters

string

csp-auth-token Optional

Access token generated from refresh token for authentication.

Parameter Serialization Style: simple

Request Body

Service of mimetype application/json Required

Payload that enables a specified service for a specified organization.

Authentication

This operation uses the following authentication methods.

csp-auth-token

Response

Response Body

204 No Content

Returns Service of type */*

No Content

{
    "accessibility": "PAID",
    "canBeEnabled": true,
    "commitContractSigned": true,
    "configuratorEnabled": true,
    "customSvcAccessTypes": [
        {
            "displayName": "...",
            "enabled": true,
            "name": "...",
            "type": "..."
        },
        {
            "displayName": "...",
            "enabled": true,
            "name": "...",
            "type": "..."
        }
    ],
    "descriptionLong": "...",
    "descriptionShort": "...",
    "disableConsoleAccess": true,
    "disableProvisioningAtTenant": true,
    "displayName": "...",
    "enabled": true,
    "enabledAsAddOn": true,
    "id": "...",
    "infraService": true,
    "name": "...",
    "productFamilies": [
        "...",
        "..."
    ],
    "productIdentifier": "...",
    "resourceBasedService": true,
    "resourceTypes": [
        "INSTANCE",
        "INSTANCE"
    ],
    "serviceExtensions": [
        {
            "name": "...",
            "state": "OPEN"
        },
        {
            "name": "...",
            "state": "COMPLETED"
        }
    ],
    "serviceIcon": "...",
    "serviceInstances": [
        {
            "default": true,
            "displayName": "...",
            "id": "...",
            "isDefault": true,
            "roles": [
                "...",
                "..."
            ],
            "serviceId": "...",
            "url": "..."
        },
        {
            "default": true,
            "displayName": "...",
            "id": "...",
            "isDefault": true,
            "roles": [
                "...",
                "..."
            ],
            "serviceId": "...",
            "url": "..."
        }
    ],
    "serviceNavBarIcon": "...",
    "serviceObjectExtention": {
        "objectMetaData": {
            "property1": "...",
            "property2": "..."
        },
        "objectType": {
            "displayName": "...",
            "enabled": true,
            "name": "...",
            "type": "..."
        }
    },
    "serviceOrgId": "...",
    "serviceRoles": [
        {
            "associatedResources": [
                "...",
                "..."
            ],
            "defaultRole": true,
            "displayName": "...",
            "enabled": true,
            "hidden": true,
            "memberType": "DIRECT",
            "mspDefaultRole": true,
            "mspDefaultRoleOfProviderAtTenant": true,
            "name": "...",
            "resource": "...",
            "roleId": "...",
            "status": "..."
        },
        {
            "associatedResources": [
                "...",
                "..."
            ],
            "defaultRole": true,
            "displayName": "...",
            "enabled": true,
            "hidden": true,
            "memberType": "GROUP",
            "mspDefaultRole": true,
            "mspDefaultRoleOfProviderAtTenant": true,
            "name": "...",
            "resource": "...",
            "roleId": "...",
            "status": "..."
        }
    ],
    "serviceState": "AVAILABLE",
    "serviceUrls": {
        "offerConfiguration": "...",
        "requestAccess": "...",
        "serviceHome": "...",
        "termsOfService": "..."
    },
    "trialDetails": {
        "endTime": 12345,
        "startTime": 12345,
        "status": "ENDED"
    },
    "visible": true
}

boolean

configuratorEnabled Required

The flag to enable the configurator.

boolean

infraService Required

The flag to enable/ disable the infra services.

Accessibility

accessibility Optional

Defines the properties of the Accessibility.

Possible values are: FREE , TRIAL , PAID

boolean

commitContractSigned Optional

The flag to identify the signed commit contract.

array of ServiceObjectType

customSvcAccessTypes Optional

The list of object service object type.

string

descriptionLong Optional

The elaborated description of the service.

string

descriptionShort Optional

The short description of the service.

boolean

disableConsoleAccess Optional

The flag to disable the console access of the service.

boolean

disableProvisioningAtTenant Optional

The flag to disable provisioning at the tenant level.

string

displayName Optional

The display name of the service.

boolean

enabled Optional

The flag to identify the whether the service is enabled.

boolean

enabledAsAddOn Optional

The flag to enable a service as an add on.

string

id Optional

The ID of the service.

boolean

canBeEnabled Optional

The flag to enable/ disable a service.

string

name Optional

The name of the service.

array of string

productFamilies Optional

The list of the product families.

string

productIdentifier Optional

The product identifier of the service.

boolean

resourceBasedService Optional

The flag to enable/ disable resource based service.

array of ResourceType

resourceTypes Optional

Defines the properties of the Resource type.

Possible values are: INSTANCE

array of ServiceExtension

serviceExtensions Optional

The list of object of service extensions.

string

serviceIcon Optional

The icon of the service.

array of ServiceInstanceDto

serviceInstances Optional

The list of service instances.

string

serviceNavBarIcon Optional

The sevice nav bar icon of the service.

ServiceObjectExtention

serviceObjectExtention Optional

Defines the properties of the Service object extension.

string

serviceOrgId Optional

The service org id of the service.

array of ServiceRole

serviceRoles Optional

The list of the service roles.

ServiceStateType

serviceState Optional

Defines the properties of the Service state type.

Possible values are: AVAILABLE , TRIAL , ORDERED

ServiceUrlsDefinition

serviceUrls Optional

Defines the properties of the Service urls definition.

string

trialCompletionDate Optional

The end date of the trail of a service.

ServiceTrialDetails

trialDetails Optional

Defines the properties of the Service trial details.

boolean

visible Optional

The flag to mark the visibilty of the service.

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

curl -X PATCH -H "csp-auth-token: string" -H "Content-Type: application/json" -d '{"accessibility":"PAID","canBeEnabled":true,"commitContractSigned":true,"configuratorEnabled":true,"customSvcAccessTypes":[{"displayName":"...","enabled":true,"name":"...","type":"..."},{"displayName":"...","enabled":true,"name":"...","type":"..."}],"descriptionLong":"...","descriptionShort":"...","disableConsoleAccess":true,"disableProvisioningAtTenant":true,"displayName":"...","enabled":true,"enabledAsAddOn":true,"id":"...","infraService":true,"name":"...","productFamilies":["...","..."],"productIdentifier":"...","resourceBasedService":true,"resourceTypes":["INSTANCE","INSTANCE"],"serviceExtensions":[{"name":"...","state":"OPEN"},{"name":"...","state":"COMPLETED"}],"serviceIcon":"...","serviceInstances":[{"default":true,"displayName":"...","id":"...","isDefault":true,"roles":["...","..."],"serviceId":"...","url":"..."},{"default":true,"displayName":"...","id":"...","isDefault":true,"roles":["...","..."],"serviceId":"...","url":"..."}],"serviceNavBarIcon":"...","serviceObjectExtention":{"objectMetaData":{"property1":"...","property2":"..."},"objectType":{"displayName":"...","enabled":true,"name":"...","type":"..."}},"serviceOrgId":"...","serviceRoles":[{"associatedResources":["...","..."],"defaultRole":true,"displayName":"...","enabled":true,"hidden":true,"memberType":"DIRECT","mspDefaultRole":true,"mspDefaultRoleOfProviderAtTenant":true,"name":"...","resource":"...","roleId":"...","status":"..."},{"associatedResources":["...","..."],"defaultRole":true,"displayName":"...","enabled":true,"hidden":true,"memberType":"GROUP","mspDefaultRole":true,"mspDefaultRoleOfProviderAtTenant":true,"name":"...","resource":"...","roleId":"...","status":"..."}],"serviceState":"AVAILABLE","serviceUrls":{"offerConfiguration":"...","requestAccess":"...","serviceHome":"...","termsOfService":"..."},"trialDetails":{"endTime":12345,"startTime":12345,"status":"ENDED"},"visible":true}' https://console.navigator.vmware.com/cphub/api/core/v1/mgmt/orgs/{orgId}/services/{serviceDefinitionId}

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

cloud-partner-navigator

Lifecycle Management Operations

post

Create Additional Provider Org

post

Create Tenant

post

Deactiavte Tenant

patch

Enable Service

get

Get Additional Provider Orgs

get

Get Org

post

Get Paginated Tenants

get

Get Payment Method

get

Get Services Of Org

get

Get Tenants

put

Update Additional Provider Org

put

Update Org

Enable Service

Request

URL

Path Parameters

Header Parameters

Request Body

Authentication

csp-auth-token

Response

Response Body

204 No Content

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

On This Page

Lifecycle Management Operations

Was this page helpful?