Team

PreviousService NextVulnerability

Last updated 2 months ago

Update team catalog entity.

patch

/public/v1/catalog/entities/team/{id}

Path parameters

idstringrequired

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

replaceMetadataTagsboolean

Replace metadata tags with the provided list

linksobject[]

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

metaTagsobject[]

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

permissionsPatternsstring[]

parentsobject[]

Catalog entity's parents, replaces the existing parents list

generalAccessstring · enum[]

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

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://app.configure8.io/public/v1/catalog/entities/team/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"links":[{"url":"text","title":"text","icon":"text"}],"metaTags":[{"name":"text","value":"text","type":"JSON","createdBy":"MANUAL"}],"permissionsPatterns":[null],"parents":[{"id":"text","secondaryId":"text","field":"text","label":"belongs_to"}],"generalAccess":["read"],"permissions":{"ANY_ADDITIONAL_PROPERTY":["create"]}}'

200

400

401

403

404

422

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "description": "text",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2025-02-21T18:00:20.397Z",
  "lastChangedDateTime": "2025-02-21T18:00:20.397Z",
  "type": "application",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "field": "text",
      "label": "belongs_to"
    }
  ],
  "generalAccess": [
    "read"
  ],
  "permissions": {
    "ANY_ADDITIONAL_PROPERTY": [
      "create"
    ]
  }
}

Create new team catalog entity.

post

/public/v1/catalog/entities/team