Skip to main content
Kinetic Community

Spaces

Operation List

GET /space Retrieve Space
PUT /space Update Space

Resource Schema

Available Includes

  • details
  • bridges
  • bridgeModels
  • bridgeMappings
  • kapps
  • securityPolicyDefinitions
  • securityPolicies
  • spaceAttributeDefinitions
  • userAttributeDefinitions
  • webhooks

Operations

Retrieve Space

GET /space

Retrieves the space.

Request

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "space": {
    "name": "Acme",
    "slug": "acme",
    "afterLogoutPath": "",
    "displayType": "Page",
    "displayValue": "space.jsp",
    "loginPage": "login.jsp",
    "resetPasswordPage": "resetPassword.jsp",
    "sessionInactiveLimitInSeconds": 604800,
    "attributes": [],
    "bridges": [],
    "bridgeModels": [],
    "fileStore": {
      "filehubUrl": "https://filehub.acme.com",
      "key": "ADM84LG",
      "slug": "s3-development"
    },
    "kapps": [],
    "spaceAttributeDefinitions": [],
    "userAttributeDefinitions": [],
    "webhooks": []
  }
}

Update Space

PUT /space

Updates the Space with the property values sent in the request body.

NOTE All properties in the request body are optional, and only the properties supplied will be updated.

The user must have Space management privileges to perform this action.

Request

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "Acme",
  "slug": "acme",
  "afterLogoutPath": "",
  "displayType": "Page",
  "displayValue": "space.jsp",
  "loginPage": "login.jsp",
  "resetPasswordPage": "resetPassword.jsp",
  "sessionInactiveLimitInSeconds": 604800,
  "attributes": [],
  "bridges": [],
  "bridgeModels": [],
  "fileStore": {
    "filehubUrl": "https://filehub.acme.com",
    "key": "ADM84LG",
    "secret": "41F4721NI81B3QK0MUTTQHNNLO",
    "slug": "s3-development"
  },
  "kapps": [],
  "spaceAttributeDefinitions": [],
  "userAttributeDefinitions": [],
  "webhooks": []
}

Response

Body
{
  "space": {
    "name": "Acme",
    "slug": "acme",
    "afterLogoutPath": "",
    "displayType": "Page",
    "displayValue": "space.jsp",
    "loginPage": "login.jsp",
    "resetPasswordPage": "resetPassword.jsp",
    "sessionInactiveLimitInSeconds": 604800,
    "attributes": [],
    "bridges": [],
    "bridgeModels": [],
    "fileStore": {
      "filehubUrl": "https://filehub.acme.com",
      "key": "ADM84LG",
      "slug": "s3-development"
    },
    "kapps": [],
    "spaceAttributeDefinitions": [],
    "userAttributeDefinitions": [],
    "webhooks": []
  }
}

 

Related