Powered by Algolia

    Tenants

    https://api.spectrocloud.com/v1alpha1/tenants

    summary:
    Retrieves a list of tenants
    Parameters:
    NameTypeDescriptionRequired
    fieldsstringSet of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.nameno
    filtersstringFilters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws Server will be restricted to certain fields based on the indexed data for each resource.no
    orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
    limitintegerlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.no
    continuestringcontinue token for the datasetno
    200
    An array of tenants
    {
    "items": [
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "authType": "string",
    "orgName": "string",
    "planUid": "string"
    },
    "status": {
    "cleanUpStatus": {
    "cleanUpError": "string",
    "cleanUpStages": "string",
    "cleanUpTimestamp": "date-time",
    "cleanedResources": [
    "string"
    ],
    "isCompleted": "boolean",
    "isInProgress": "boolean"
    },
    "isActive": "boolean"
    }
    }
    ],
    "listmeta": {
    "continue": "string",
    "count": "integer"
    }
    }

    https://api.spectrocloud.com/v1alpha1/tenants

    summary:
    Creates a tenant
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "authType": "string",
    "emailId": "string",
    "firstName": "string",
    "lastName": "string",
    "orgName": "string",
    "roles": [
    "string"
    ]
    }
    }
    201
    Created successfully
    {
    "uid": "string"
    }

    https://api.spectrocloud.com/v1alpha1/tenants/validate

    summary:
    Validate tenant
    {
    "emailId": "string",
    "orgName": "string"
    }
    204
    Ok reponse without content

    https://api.spectrocloud.com/v1alpha1/tenants/{tenantUid}

    summary:
    Returns the specified tenant
    Path parameters:
    NameTypeDescriptionRequired
    tenantUidstringyes
    200
    OK
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "authType": "string",
    "orgName": "string",
    "planUid": "string"
    },
    "status": {
    "cleanUpStatus": {
    "cleanUpError": "string",
    "cleanUpStages": "string",
    "cleanUpTimestamp": "date-time",
    "cleanedResources": [
    "string"
    ],
    "isCompleted": "boolean",
    "isInProgress": "boolean"
    },
    "isActive": "boolean"
    }
    }

    https://api.spectrocloud.com/v1alpha1/tenants/{tenantUid}

    summary:
    Deletes the specified tenant
    Path parameters:
    NameTypeDescriptionRequired
    tenantUidstringyes
    204
    The resource was updated successfully

    https://api.spectrocloud.com/v1alpha1/tenants/{tenantUid}

    summary:
    Patches the specified tenant
    Path parameters:
    NameTypeDescriptionRequired
    tenantUidstringyes
    {
    "items": {
    "from": "string",
    "op": "string",
    "path": "string",
    "value": "object"
    }
    }
    204
    The resource was updated successfully

    https://api.spectrocloud.com/v1alpha1/tenants/{tenantUid}/cleanUp

    summary:
    Clean up tenant resources
    Path parameters:
    NameTypeDescriptionRequired
    tenantUidstringyes
    204
    The resource was updated successfully

    https://api.spectrocloud.com/v1alpha1/tenants/{tenantUid}/invoices

    summary:
    Retrieves a list of invoices
    Path parameters:
    NameTypeDescriptionRequired
    tenantUidstringyes
    200
    OK
    {
    "invoices": [
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "credits": {
    "creditsToBeCharged": "number",
    "overageCharges": "number",
    "paymentAmount": "number",
    "paymentUnit": "string",
    "usedCredits": "number"
    },
    "month": "date-time",
    "paymentTransactionId": "string",
    "plan": {
    "freeCredits": [
    {
    "cpuCoreHours": "number",
    "creditUid": "string",
    "expiry": "date-time",
    "start": "date-time"
    }
    ],
    "plantype": "string",
    "slaCredits": [
    {
    "cpuCoreHours": "number",
    "creditUid": "string",
    "expiry": "date-time",
    "start": "date-time"
    }
    ]
    },
    "project": [
    {
    "projectUid": "string",
    "usage": "number"
    }
    ]
    },
    "status": {
    "paymentDate": "date-time",
    "paymentMsg": "string",
    "state": "string"
    }
    }
    ],
    "listmeta": {
    "continue": "string",
    "count": "integer"
    }
    }

    https://api.spectrocloud.com/v1alpha1/tenants/{tenantUid}/invoices/{invoiceUid}

    summary:
    Returns the specified invoice
    Path parameters:
    NameTypeDescriptionRequired
    tenantUidstringyes
    invoiceUidstringyes
    200
    OK
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "credits": {
    "creditsToBeCharged": "number",
    "overageCharges": "number",
    "paymentAmount": "number",
    "paymentUnit": "string",
    "usedCredits": "number"
    },
    "month": "date-time",
    "paymentTransactionId": "string",
    "plan": {
    "freeCredits": [
    {
    "cpuCoreHours": "number",
    "creditUid": "string",
    "expiry": "date-time",
    "start": "date-time"
    }
    ],
    "plantype": "string",
    "slaCredits": [
    {
    "cpuCoreHours": "number",
    "creditUid": "string",
    "expiry": "date-time",
    "start": "date-time"
    }
    ]
    },
    "project": [
    {
    "projectUid": "string",
    "usage": "number"
    }
    ]
    },
    "status": {
    "paymentDate": "date-time",
    "paymentMsg": "string",
    "state": "string"
    }
    }

    https://api.spectrocloud.com/v1alpha1/tenants/{tenantUid}/isCleanedUp

    summary:
    Get cleaned up tenant resources
    Path parameters:
    NameTypeDescriptionRequired
    tenantUidstringyes
    200
    OK
    {
    "activeResources": {
    "activeResources": "object"
    },
    "tenantStatus": {
    "cleanUpError": "string",
    "cleanUpStages": "string",
    "cleanUpTimestamp": "date-time",
    "cleanedResources": [
    "string"
    ],
    "isCompleted": "boolean",
    "isInProgress": "boolean"
    }
    }

    https://api.spectrocloud.com/v1alpha1/tenants/{tenantUid}/password/policy

    summary:
    retrieves the password policy for tenant
    Path parameters:
    NameTypeDescriptionRequired
    tenantUidstringyes
    200
    (empty)
    {
    "creationTimestamp": "date-time",
    "expiryDurationInDays": "integer",
    "firstReminderInDays": "integer",
    "isRegex": "boolean",
    "minLength": "integer",
    "minNumOfBlockLetters": "integer",
    "minNumOfDigits": "integer",
    "minNumOfSmallLetters": "integer",
    "minNumOfSpecialCharacters": "integer",
    "regex": "string",
    "updateTimestamp": "date-time"
    }

    https://api.spectrocloud.com/v1alpha1/tenants/{tenantUid}/password/policy

    summary:
    creates or updates a password policy for tenant
    Path parameters:
    NameTypeDescriptionRequired
    tenantUidstringyes
    {
    "creationTimestamp": "date-time",
    "expiryDurationInDays": "integer",
    "firstReminderInDays": "integer",
    "isRegex": "boolean",
    "minLength": "integer",
    "minNumOfBlockLetters": "integer",
    "minNumOfDigits": "integer",
    "minNumOfSmallLetters": "integer",
    "minNumOfSpecialCharacters": "integer",
    "regex": "string",
    "updateTimestamp": "date-time"
    }
    204
    The resource was updated successfully

    https://api.spectrocloud.com/v1alpha1/tenants/{tenantUid}/plan

    summary:
    Returns the current tenant's plan
    Path parameters:
    NameTypeDescriptionRequired
    tenantUidstringyes
    200
    (empty)
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "string",
    "deletionTimestamp": "string",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "cost": {
    "discount": "number",
    "price": "number"
    },
    "expiry": "date-time",
    "freeCredits": [
    {
    "cpuCoreHours": "number",
    "creditUid": "string",
    "expiry": "date-time",
    "start": "date-time"
    }
    ],
    "planLimit": {
    "cpuCoreHours": "integer",
    "isOnDemand": "boolean",
    "overageLimitPercentage": "integer",
    "warnLimitPercentage": "integer"
    },
    "renewal": {
    "expiry": "date-time",
    "planLimit": {
    "cpuCoreHours": "integer",
    "isOnDemand": "boolean",
    "overageLimitPercentage": "integer",
    "warnLimitPercentage": "integer"
    },
    "start": "date-time",
    "type": "string"
    },
    "slaCredits": [
    {
    "cpuCoreHours": "number",
    "creditUid": "string",
    "expiry": "date-time",
    "start": "date-time"
    }
    ],
    "start": "date-time",
    "type": "string"
    },
    "status": {
    "changeLogs": [
    "string"
    ]
    }
    }

    https://api.spectrocloud.com/v1alpha1/tenants/{tenantUid}/plans/usage/monthly

    summary:
    Returns the tenant's monthly planUsage grouped by projects
    Path parameters:
    NameTypeDescriptionRequired
    tenantUidstringyes
    endDatestringno
    startDatestringyes
    200
    OK
    {
    "items": [
    {
    "dailyUsages": [
    {
    "projects": [
    {
    "cpuCoreHours": "number",
    "project": {
    "name": "string",
    "uid": "string"
    }
    }
    ],
    "timestamp": "date-time",
    "totalCpuCoreHours": "number"
    }
    ],
    "month": "date-time",
    "planLimit": {
    "cpuCoreHours": "integer",
    "isOnDemand": "boolean",
    "overageLimitPercentage": "integer",
    "warnLimitPercentage": "integer"
    },
    "planType": "string",
    "planUid": "string",
    "totalMonthlyUsage": {
    "projects": [
    {
    "cpuCoreHours": "number",
    "project": {
    "name": "string",
    "uid": "string"
    }
    }
    ],
    "totalCpuCoreHours": "number"
    }
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/tenants/{tenantUid}/saml/metadata

    summary:
    Returns the specified service provider metadata and Saml Spec for tenant
    Path parameters:
    NameTypeDescriptionRequired
    tenantUidstringyes
    200
    OK
    {
    "acsUrl": "string",
    "attributes": [
    {
    "attributeValue": "string",
    "name": "string",
    "nameFormat": "string"
    }
    ],
    "audienceUrl": "string",
    "defaultTeams": [
    "string"
    ],
    "entityId": "string",
    "federationMetadata": "string",
    "identityProvider": "string",
    "isSsoEnabled": "boolean",
    "nameIdFormat": "string",
    "serviceProviderMetadata": "string"
    }

    https://api.spectrocloud.com/v1alpha1/tenants/{tenantUid}/saml/metadata

    summary:
    Associates the specified federation metadata for the tenant
    Parameters:
    NameTypeDescriptionRequired
    federationMetaDataFilefileThe file to upload.no
    federationMetaDatastringThe federationMetadata to upload.no
    isSsoEnabledbooleanThe isSsoEnabled flag.yes
    identityProviderstringThe identityProvider name.yes
    defaultTeamsarrayThe default team for the sso user.no
    Path parameters:
    NameTypeDescriptionRequired
    tenantUidstringyes
    204
    The resource was updated successfully

    https://api.spectrocloud.com/v1alpha1/tenants/{tenantUid}/usage/cpuCoreHours

    summary:
    Returns the tenant's cpu corehours usages grouped by projects
    Path parameters:
    NameTypeDescriptionRequired
    tenantUidstringyes
    endTimestringTime is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.no
    startTimestringTime is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.no
    200
    OK
    {
    "hourlyUsages": [
    {
    "projects": [
    {
    "cpuCoreHours": "number",
    "project": {
    "name": "string",
    "uid": "string"
    }
    }
    ],
    "timestamp": "date-time",
    "totalCpuCoreHours": "number"
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/tenants/{tenantUid}/user

    summary:
    Returns the user object of the specified tenant
    Path parameters:
    NameTypeDescriptionRequired
    tenantUidstringyes
    200
    OK
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "string",
    "deletionTimestamp": "string",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "emailId": "string",
    "firstName": "string",
    "lastName": "string",
    "roles": [
    "string"
    ]
    },
    "status": {
    "isActive": "boolean",
    "lastSignIn": "date-time"
    }
    }

    https://api.spectrocloud.com/v1alpha1/tenants/{tenantUid}/user

    summary:
    Updates the user object of the tenant
    Path parameters:
    NameTypeDescriptionRequired
    tenantUidstringyes
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "string",
    "deletionTimestamp": "string",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "emailId": "string",
    "firstName": "string",
    "lastName": "string",
    "roles": [
    "string"
    ]
    },
    "status": {
    "isActive": "boolean",
    "lastSignIn": "date-time"
    }
    }
    204
    The resource was updated successfully

    https://api.spectrocloud.com/v1alpha1/tenants/{tenantUid}/user

    summary:
    Creates an user using sysadmin privileges on behalf of the tenant
    Path parameters:
    NameTypeDescriptionRequired
    tenantUidstringyes
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "string",
    "deletionTimestamp": "string",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "emailId": "string",
    "firstName": "string",
    "lastName": "string",
    "roles": [
    "string"
    ],
    "teams": [
    "string"
    ]
    }
    }
    201
    Created successfully
    {
    "uid": "string"
    }