Team

Create new team catalog entity.

POSThttps://app.configure8.io/public/v1/catalog/entities/team

Body

name*string

Name of the entity

descriptionstring

Description of the entity

linksarray of MetadataLinkDto (object)

List of URLs linked to this entity

metaTagsarray of MetadataTagDto (object)

List of metadata tags linked to this entity

permissionsobject

List of permissions linked to this entity. The 'permissions' property is an optional object where the keys can represent either user identifier or team identifier, and the value is array of the permissions ("create", "delete", "execute", "modify", "read") associated with each user or team.

generalAccessarray of enum

Entity visibility control. By default it is set to a default access control on organization level

parentsarray of EntityParentDto (object)

Catalog entity's parents

Response

Body

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteambaserangecostvulnerability

descriptionstring

Catalog entity description

metaTagsarray of MetadataTagDto (object)

Catalog entity's metadata

linksarray of MetadataLinkDto (object)

Catalog entity's links

parentsarray of EntityParentDto (object)

Catalog entity's parents

createdBystring

lastChangedBystring

createDateTimestring (date-time)

lastChangedDateTimestring (date-time)

permissionsobject

generalAccessarray of enum

Entity visibility control. By default it is set to a default access control on organization level

Request

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities/team', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to",
      "field": "text"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-11-21T06:48:17.662Z",
  "lastChangedDateTime": "2024-11-21T06:48:17.662Z",
  "generalAccess": [
    "read"
  ]
}

Update team catalog entity.

PATCHhttps://app.configure8.io/public/v1/catalog/entities/team/{id}

Path parameters

id*string

Entity id

Body

namestring

Catalog entity name, should be unique, not updatable for discovery created catalog entity

descriptionstring

Catalog entity description, not updatable for discovery created catalog entity

linksarray of MetadataLinkDto (object)

List of URLs linked to this entity, replaces the existing list

metaTagsarray of MetadataTagDto (object)

List of metadata tags linked to this entity, replaces the existing list

permissionsobject

permissionsPatternsarray of string

generalAccessarray of enum

Entity visibility control. By default it is set to a default access control on organization level

parentsarray of EntityParentDto (object)

Catalog entity's parents, replaces the existing parents list

Response

Body

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteambaserangecostvulnerability

descriptionstring

Catalog entity description

metaTagsarray of MetadataTagDto (object)

Catalog entity's metadata

linksarray of MetadataLinkDto (object)

Catalog entity's links

parentsarray of EntityParentDto (object)

Catalog entity's parents

createdBystring

lastChangedBystring

createDateTimestring (date-time)

lastChangedDateTimestring (date-time)

permissionsobject

generalAccessarray of enum

Entity visibility control. By default it is set to a default access control on organization level

Request

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities/team/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to",
      "field": "text"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-11-21T06:48:17.662Z",
  "lastChangedDateTime": "2024-11-21T06:48:17.662Z",
  "generalAccess": [
    "read"
  ]
}

PreviousService NextVulnerability

Last updated 2 months ago

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities/team', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "name": "text" }), }); const data = await response.json();

{ "id": "text", "name": "text", "orgId": "text", "type": "application", "description": "text", "metaTags": [ { "name": "text", "value": "text", "type": "JSON", "createdBy": "MANUAL" } ], "links": [ { "url": "text", "title": "text", "icon": "text" } ], "parents": [ { "id": "text", "secondaryId": "text", "label": "belongs_to", "field": "text" } ], "createdBy": "text", "lastChangedBy": "text", "createDateTime": "2024-11-21T06:48:17.662Z", "lastChangedDateTime": "2024-11-21T06:48:17.662Z", "generalAccess": [ "read" ] }

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities/team/{id}', { method: 'PATCH', headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();