Initiate Federated Link from Parent CCM

 

API Details
Name

Initiate Federated Link from Parent CCM

Description

During the federated registration process, the tenant admin for the Parent CCM initiates the request to link to a Subordinate CCM by providing the Child CCM's URL and Tenant Name along with the tenant admin's credentials (email and password).

MethodPOST
URI

v1/tenants/tenantId/links

CloudCenter ReleaseIntroduced in CloudCenter 4.3.
Notes
  • Available in CloudCenter 4.3 to 4.5.
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • To allow a parent CCM to manage the subordinate CCM, the subordinate CCM tenant administrator must be registered with the parent CCM tenant. Admins can link:

    • One Subordinate CCM tenant to only one Parent CCM tenant
    • Multiple tenants within one Subordinate CCM to one Parent CCM tenant
  • The Child CCM tenant admin receives an email and a system notification on the first login after the request is sent.
ESB Headeraction: create.tenants.tenantId.links
curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<ParentCCM _HOST>:<PORT>/v1/tenants/1/links/3"
{
    "name":"CCM4 - T0 ",
    "remoteEndpoint": "https://<ChildCCM_HOST>:<PORT>",
    "userName": "admin@cliqrtech.com",
    "password": "===redacted===",
    "requestComment": "",
    "relation": "CLOUD_CENTER_LINK_TO_CHILD",
    "tenantId": 1,
    "remoteTenantShortName": "CloudCenter",
    "status": "PENDING"
}
{
    "id": "7",
    "resource": "https://<ParentCCM_HOST>:<PORT>/v1/tenants/1/links/",
    "perms": ["read", "delete", "remote_app_profile_creation", "manage", "remote_termination", "administration", "remote_launch", "remote_policy_creation", "write"],
    "name": "CCM4-T0",
    "description": null,
    "tenantId": "1",
    "disabled": false,
    "status": "PENDING",
    "lastApproved": null,
    "lastUpdated": 1464897593771,
    "created": 1464897593771,
    "remoteTenantId": "1",
    "remoteTenantShortName": "CloudCenter",
    "remoteCloudCenterId": "ccm4",
    "remoteEndpoint": "https://<ChildCCM_HOST>:<PORT>",
    "remoteLinkId": "3",
    "relation": "CLOUD_CENTER_LINK_TO_CHILD",
    "approvedLinkState": "DID_NOT_CHECK",
    "requestComment": "",
    "rejectReason": null,
    "requesterName": "CloudCenter Admin",
    "userName": null,
    "password": null,
    "remoteCaCert": null,
    "remoteLaunchOk": false,
    "remoteTerminationOk": true,
    "remotePolicyCreationOk": false,
    "remoteAppProfileCreationOk": false
}

  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String

  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

  • Description: Unique URL to access the remote federated CCM server. See Federated CCM Management for additional context.
  • Type: String
  • Description: Unique, CloudCenter-generated name reference for this user.
  • Type: String
  • Description: Password for the user's account. Effective Cloud Center 4.6.1, the CloudCenter platform enforces a minimum password length of 5 characters for all settings.
  • Type: String
  • Description: Comments or descriptions about the federated link request and can include information on the reason(s), requester information, and so forth.
  • Type: String
  • Description: Identifies the relation between the tenantId and the remoteTenantId in a federated environment. 

  • Type: Enumeration

    EnumerationDescription
    CLOUD_CENTER_LINK_TO_PARENT Indicates that this server is the Child CCM.
    CLOUD_CENTER_LINK_TO_CHILDIndicates that this server is the Parent CCM.

  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String

  • Description: Unique short version of this federated CCM tenant's name to be used in the Login page. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency. See Federated CCM Management for additional context.
  • Type: String
  • Description: Status of the operation. See Deployment and VM States for a list of all job operations.
  • Type: Enumeration

    EnumerationDescription
    SUBMITTEDThe operation has been submitted
    RUNNINGThe operation is currently in progress
    SUCCESSThe operation succeeded
    FAILThe operation failed
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
  • Description: Unique URL to access this resource.
  • Type: String

See pageResource or Pagination for additional context

  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String
  • Description: Indicates whether this resource is disabled.
    • True = resource is disabled
    • false = resource is not disabled
  • Type: Boolean
  • Description: Status of the operation. See Deployment and VM States for a list of all job operations.
  • Type: Enumeration

    EnumerationDescription
    SUBMITTEDThe operation has been submitted
    RUNNINGThe operation is currently in progress
    SUCCESSThe operation succeeded
    FAILThe operation failed
  • Description: If the connection was successfully established, this is the date when this resource was last approved. See Federated CCM Management for additional context.

  • Type: Long

  • Description: Date that this resource was last updated. This attribute is the same as the lastUpdatedTime attribute.

  • Type: Long

  • Description: The date that this resource or favorite was created (system generated). This is a read-only attribute and cannot be configured.
  • Type: Long
  • Description: Unique, system-generated identifier for the federated tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Federated CCM Management for additional context.
  • Type: String
  • Description: Unique short version of this federated CCM tenant's name to be used in the Login page. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency. See Federated CCM Management for additional context.
  • Type: String
  • Description: Unique, system-generated identifier for the federated CCM's CloudCenter ID (CCID). This ID is auto-generated by CloudCenter. See Certificate Authentication and Federated CCM Management for additional context.

    When submitting jobs from a linked Child CCM in a Federated CCM environment, use the additional target CCID parameter, -H "x-cliqr-ccid: ccm4", in the HTTP header. In place of ccm4, use your remote deployment identifier, CloudCenter ID (CCID) – remoteCloudCenterId, that is included in the response to the View Child CCM Details API call.

  • Type: String
  • Description: Unique URL to access the remote federated CCM server. See Federated CCM Management for additional context.
  • Type: String
  • Description: Once the tenant admin for the Subordinate (child) CCM approves the link request and the federated registration is established, CloudCenter assigns a a unique, system-generated identifier for the link. See Federated CCM Management for additional context.
  • Type: String
  • Description: Identifies the relation between the tenantId and the remoteTenantId in a federated environment. 

  • Type: Enumeration

    EnumerationDescription
    CLOUD_CENTER_LINK_TO_PARENT Indicates that this server is the Child CCM.
    CLOUD_CENTER_LINK_TO_CHILDIndicates that this server is the Parent CCM.
  • Description: Identifies the possible states for linked CCMs in a federated environment.
  • Type: Enumeration

    EnumerationDescription
     CONNECTED The federated CCM link is successfully established.
    CANNOT_ESTABLISH_LINKCloudCenter is unable to establish a federated CCM link between the identified CCMs.
     DISABLED The federated CCM link cannot be accessed by the remote server as the request may have been declined by the Subordinate CCM's admin.
    DID_NOT_CHECKDefault. The remote CCM admin may not have checked the link connection request and the link is still not mutually authenticated.
  • Description: Comments or descriptions about the federated link request and can include information on the reason(s), requester information, and so forth.
  • Type: String
  • Description: The reason that the federated link request was rejected.
  • Type: String
  • Description: The name of the user (on the parent CCM) who is initiating the federated link request.
  • Type: String
  • Description: Unique CloudCenter-generated name reference for this user.
  • Type: String
  • Description: Password for the user's account. Effective Cloud Center 4.6.1, the CloudCenter platform enforces a minimum password length of 5 characters for all settings.
  • Type: String
  • Description: Identifies if the child CCM administrator permitted this job to launch from the parent CCM. See Federated CCM Management > Parent CCM Link Initiation (Parent Manager Permissions – Allow App Remote Launch).
  • Type: Boolean
    • true = Allow App Remote Launch is selected.
    • false = Allow App Remote Launch is not selected.
  • Description: Identifies if the child CCM administrator permitted this job to be terminated from the parent CCM. See Federated CCM Management > Parent CCM Link Initiation (Parent Manager Permissions – Allow App Remote Termination).
  • Type: Boolean
    • trueAllow App Remote Termination is selected.
    • falseAllow App Remote Termination is not selected.
  • Description: Identifies if the child CCM administrator permitted this policy to be created from the parent CCM. See Federated CCM Management > Parent CCM Link Initiation (Parent Manager Permissions – Allow Policy Remote Creation).
  • Type: Boolean
    • trueAllow Policy Remote Creation is selected.
    • falseAllow Policy Remote Creation is not selected.
  • Description: Identifies if the child CCM administrator permitted this application profile to be created from the parent CCM. See Federated CCM Management > Parent CCM Link Initiation (Parent Manager Permissions – Allow App Profile Remote Creation).
  • Type: Boolean
    • trueAllow App Profile Remote Creation is selected.
    • falseAllow App Profile Remote Creation is not selected.