Person

• Create a person entity

• Update a person entity

Person

Create a new person catalog entity

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

Body

application/json

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

email*string

The email of this person

userIdstring

The ID of the user linked to this person

photoUrlstring

An optional URL of a photo/image to display for this person

familyNamestring

User family name

givenNamestring

User given name

externalIdstring

User external id

Response

201401403409

Body

application/json

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

email*string

The email of this person

userIdstring

The ID of the user linked to this person

photoUrlstring

An optional URL of a photo/image to display for this person

familyNamestring

User family name

givenNamestring

User given name

externalIdstring

User external id

Request

JavaScriptCurlPython

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

Response

201

{
  "name": "text",
  "description": "text",
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "generalAccess": [
    "read"
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to",
      "field": "text"
    }
  ],
  "email": "text",
  "userId": "text",
  "photoUrl": "text",
  "familyName": "text",
  "givenName": "text",
  "externalId": "text"
}

Update a person catalog entity

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

Path parameters

id*string

Unique id of catalog entity to update

Body

application/json

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

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.

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

photoUrlstring

Person photo url

familyNamestring

Person family name

givenNamestring

Person givenName name

Response

200401403404409

Body

application/json

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

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 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

email*string

isActive*boolean

userIdstring

externalIdstring

familyNamestring

givenNamestring

photoUrlstring

provisionedboolean

Request

JavaScriptCurlPython

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

Response

200

{
  "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:23:24.497Z",
  "lastChangedDateTime": "2024-11-21T06:23:24.497Z",
  "generalAccess": [
    "read"
  ],
  "email": "text",
  "isActive": false,
  "userId": "text",
  "externalId": "text",
  "familyName": "text",
  "givenName": "text",
  "photoUrl": "text",
  "provisioned": false
}