{"openapi":"3.0.0","paths":{"/public/v1/catalog/entities":{"post":{"operationId":"CatalogEntityController_getCatalogEntities","summary":"Get catalog entities filtered by query.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogEntityQueryDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogEntitiesSearchResultDto"}}}},"400":{"description":"Returned when request body is not valid"}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/{id}":{"get":{"operationId":"CatalogEntityController_getCatalogEntityById","summary":"Get a catalog entity by id.","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of catalog entity to return","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogEntityDto"}}}},"404":{"description":"Returned when catalog entity with specified id is not found"}},"tags":["Catalog Entity"]},"delete":{"operationId":"CatalogEntityController_deleteCatalogEntityById","summary":"Delete the specified catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"Unique ID for given catalog entity.","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"The requested catalog entity does not exist in the organisation."},"409":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/person":{"post":{"operationId":"CatalogEntityController_createPersonEntity","summary":"Create a new person catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogPersonDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogPersonDto"}}}},"409":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/resource/{id}":{"patch":{"operationId":"CatalogEntityController_updateResourceEntity","summary":"Update a resource catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of catalog entity to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogResourceDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogResourceDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/service/{id}":{"patch":{"operationId":"CatalogEntityController_updateServiceEntity","summary":"Update a service catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of catalog entity to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogServiceDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogServiceDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/person/{id}":{"patch":{"operationId":"CatalogEntityController_updatePersonEntity","summary":"Update a person catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of catalog entity to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogPersonDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogPersonDto"}}}},"404":{"description":""},"409":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/resource":{"post":{"operationId":"CatalogEntityController_createCatalogResourceEntity","summary":"Create a new resource catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogResourceDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogResourceDto"}}}},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/library":{"post":{"operationId":"CatalogEntityController_createCatalogLibrary","summary":"Create a new library catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogLibraryDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogLibraryDto"}}}},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/repository":{"post":{"operationId":"CatalogEntityController_createCatalogRepository","summary":"Create an new repository catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogRepositoryDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogRepositoryDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/repository/{id}":{"patch":{"operationId":"CatalogEntityController_updateRepositoryEntity","summary":"Update a repository catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of catalog entity to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogRepositoryDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogRepositoryDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/environment":{"post":{"operationId":"CatalogEntityController_createCatalogEnvironment","summary":"Create a new environment catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogEnvironmentDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogEnvironmentDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/service":{"post":{"operationId":"CatalogEntityController_createServiceEntity","summary":"Create a new service catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogServiceDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogServiceDto"}}}},"404":{"description":"Returned if the repository, owners or applications don't exist"},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/system":{"post":{"operationId":"CatalogEntityController_createCatalogSystemEntity","summary":"Create a new system catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogSystemDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogSystemDto"}}}},"409":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/application":{"post":{"operationId":"CatalogEntityController_createCatalogApplicationEntity","summary":"Create a new application catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogApplicationDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogApplicationDto"}}}},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/application/{id}":{"patch":{"operationId":"CatalogEntityController_updateApplicationEntity","summary":"Update an application catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of catalog entity to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogApplicationDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogApplicationDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/manifest":{"post":{"operationId":"CatalogEntityController_createCatalogManifestEntity","summary":"Create a new manifest catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogManifestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogManifestDto"}}}},"409":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/environment/{id}":{"patch":{"operationId":"CatalogEntityController_updateCatalogEnvironmentEntity","summary":"Update an environment catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"ID of the catalog entity.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogEnvironmentDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogEnvironmentDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/manifest/{id}":{"patch":{"operationId":"CatalogEntityController_updateCatalogManifestEntity","summary":"Update a manifest catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"ID of the catalog entity.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogManifestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogManifestDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/system/{id}":{"patch":{"operationId":"CatalogEntityController_updateCatalogSystemEntity","summary":"Update a system catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"ID of the catalog entity.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogSystemDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogSystemDto"}}}},"404":{"description":""},"409":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/library/{id}":{"patch":{"operationId":"CatalogEntityController_updateCatalogLibraryEntity","summary":"Update a library catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"ID of the catalog entity.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogLibraryDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogLibraryDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/base":{"post":{"operationId":"CatalogEntityController_createCatalogBase","summary":"Create a new base catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogBaseDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogBaseDto"}}}},"400":{"description":""},"422":{"description":""},"500":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/base/{id}":{"patch":{"operationId":"CatalogEntityController_updateCatalogBaseEntity","summary":"Update a base catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"ID of the catalog entity.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogBaseDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogBaseDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""},"500":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/batch/entities/resource":{"post":{"operationId":"CatalogEntityBatchController_createCatalogEntitiesBulk","summary":"Batch create new resource catalog entities","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CreateCatalogResourceDto"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogResourceBatchResultDto"}}}}},"tags":["Catalog Entity Batch"]}},"/public/v1/catalog/batch/entities":{"delete":{"operationId":"CatalogEntityBatchController_deleteCatalogEntitiesBulk","summary":"Batch delete the specified catalog entities","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCatalogEntitiesBatchDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCatalogEntitiesBatchResultDto"}}}}},"tags":["Catalog Entity Batch"]}},"/public/v1/catalog/relations":{"get":{"operationId":"CatalogRelationController_getCatalogEntityRelations","summary":"GET a list of catalog relations.","parameters":[{"name":"sourceId","required":false,"in":"query","description":"Id of the source entity from which we want to get, if not provided, it will return all relations of the target entity or all relations if targetId is not provided","schema":{"type":"string"}},{"name":"targetId","required":false,"in":"query","description":"Id of the target entity from which we want to get, if not provided, it will return all relations of the source entity or all relations if sourceId is not provided","schema":{"type":"string"}},{"name":"pageNumber","required":false,"in":"query","schema":{"default":0,"type":"number"}},{"name":"pageSize","required":false,"in":"query","schema":{"default":20,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogRelationResultDto"}}}}},"tags":["Catalog Relation"]},"post":{"operationId":"CatalogRelationController_createCatalogEntityRelation","summary":"Create relation between catalog entities. \n      NB: Resource-Resource relations are available only for non-discovery created resources.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogRelationDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogRelationDto"}}}},"400":{"description":"Returned when request body is not valid"},"404":{"description":"At least one of the requested catalog entities was not found"},"422":{"description":"Returned when request data cannot be processed and is logically invalid"}},"tags":["Catalog Relation"]},"delete":{"operationId":"CatalogRelationController_deleteCatalogRelationById","summary":"Delete catalog entity relation.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCatalogRelationDto"}}}},"responses":{"200":{"description":""},"404":{"description":"At least one of the requested catalog entities was not found."},"422":{"description":"It's not possible for these requested entities to have relation between each other."}},"tags":["Catalog Relation"]}},"/public/v1/catalog/metadata/{id}":{"get":{"operationId":"CatalogEntityMetadataController_getCatalogEntityMetadataById","summary":"Get catalog entity's metadata id.","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of catalog entity to return its metadata","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogEntityMetadataDto"}}}},"400":{"description":"Returned when request body is not valid"},"404":{"description":"Returned when catalog entity with specified id is not found"}},"tags":["Catalog Entity Metadata"]},"put":{"operationId":"CatalogEntityMetadataController_updateCatalogEntityMetadataById","summary":"Update catalog entity's metadata by id.","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of catalog entity to update its metadata","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogEntityMetadataUpdateDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogEntityMetadataDto"}}}},"404":{"description":"Returned when catalog entity with specified id is not found"},"422":{"description":"Returned when nickname meta tags are duplicated in category or in provider scope"}},"tags":["Catalog Entity Metadata"]}},"/public/v1/templates":{"get":{"operationId":"TemplateController_getAllTemplates","summary":"Get all the templates available.","parameters":[{"name":"name","required":false,"in":"query","description":"Templates name to filter the results","schema":{"type":"string"}},{"name":"type","required":false,"in":"query","description":"Templates type to filter the results","schema":{"enum":["core","user"],"type":"string"}},{"name":"category","required":false,"in":"query","description":"Template Category to filter the results","schema":{"enum":["create","display"],"type":"string"}},{"name":"entityType","required":false,"in":"query","description":"Template entity type to filter the results","schema":{"enum":["service"],"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateDto"}}}}}},"tags":["Templates"]}},"/public/v1/users/{id}":{"patch":{"operationId":"UserController_updateUserById","summary":"Update a user entity","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of user to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDto"}}}},"404":{"description":"Requested user not found"},"409":{"description":""}},"tags":["Users"]},"delete":{"operationId":"UserController_deleteUserById","summary":"Delete a user entity","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of user to delete","schema":{"type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"Requested user not found"},"409":{"description":""}},"tags":["Users"]}},"/public/v1/users":{"get":{"operationId":"UserController_getAllUsers","summary":"Return list of users based on the given filters","parameters":[{"name":"searchTerms","required":false,"in":"query","description":"Search term to filter users on that, Regex expressions can be used too","schema":{"type":"string"}},{"name":"pageNumber","required":false,"in":"query","description":"Page number for getting results","schema":{"default":0,"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"How many users should be included in one page","schema":{"default":20,"type":"number"}},{"name":"sortProperty","required":false,"in":"query","description":"Sort the result based on this property","schema":{"default":"lastName","enum":["id","firstName","lastName","email","displayName","orgId","status","role","photoUrl","acceptedTermsOfServiceAndPrivacyPolicyAt","createdAt","updatedAt","lastChangedBy","lastLoginAt"],"type":"string"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort order","schema":{"default":"ASC","enum":["ASC","DESC"],"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsersPageDto"}}}}},"tags":["Users"]}},"/public/v1/scorecards/{id}/run":{"post":{"operationId":"ScorecardController_createScorecardSchedule","summary":"Trigger a reevaluate for the given scorecard","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of scorecard","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleDto"}}}},"404":{"description":"Requested scorecard not found"}},"tags":["Scorecard"]}},"/public/v1/scorecards":{"get":{"operationId":"ScorecardController_getScorecards","summary":"GET an organizational list of scorecard definitions optionally filtered.","parameters":[{"name":"name","required":false,"in":"query","description":"Filter based on scorecard definition name","schema":{"type":"string"}},{"name":"serviceId","required":false,"in":"query","description":"Filter based on scorecard definition service id","schema":{"type":"string"}},{"name":"pageNumber","required":false,"in":"query","description":"Page number to return","schema":{"default":0,"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Number of items to return per page","schema":{"default":20,"type":"number"}},{"name":"sortProperty","required":false,"in":"query","description":"Sort property","schema":{"default":"name","enum":["orgId","id","name","createdAt","updatedAt","lastChangedBy","createdBy","startAt","dueAt","status","isEvaluating","evaluatedAt","evaluateTotal","evaluatePassed","evaluateFailed","evaluatePercentage","evaluateServicesPercentage"],"type":"string"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort order","schema":{"default":"ASC","enum":["ASC","DESC"],"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScorecardPageDto"}}}}},"tags":["Scorecard"]}},"/public/v1/scorecards/{id}/metrics":{"get":{"operationId":"ScorecardController_getMetricsByScorecardId","summary":"Get scorecard metrics","parameters":[{"name":"id","required":true,"in":"path","description":"Filter by scorecard service id","schema":{"type":"string"}},{"name":"name","required":false,"in":"query","description":"Filter metrics by name","schema":{"type":"string"}},{"name":"onlySystem","required":false,"in":"query","description":"Filter metrics by system metrics only","schema":{"type":"boolean"}},{"name":"pageNumber","required":false,"in":"query","description":"Page number to return","schema":{"default":0,"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Number of items to return per page","schema":{"default":20,"type":"number"}},{"name":"sortProperty","required":false,"in":"query","description":"Sort property","schema":{"default":"name","enum":["id","measurementId","name","comparisonOperator","comparisonType","threshold","passOnNoData","category","createdAt","updatedAt","lastChangedBy","createdBy"],"type":"string"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort order","schema":{"default":"ASC","enum":["ASC","DESC"],"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScorecardMetricPageDto"}}}},"404":{"description":"Scorecard is not found"}},"tags":["Scorecard"]}},"/public/v1/scorecards/{id}/results":{"get":{"operationId":"ScorecardController_getScorecardMetricResults","summary":"Get a scorecard results","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of scorecard","schema":{"type":"string"}},{"name":"serviceId","required":false,"in":"query","description":"Service id to filter the results","schema":{"nullable":false,"type":"string"}},{"name":"metricId","required":false,"in":"query","description":"Metric id to filter the results","schema":{"nullable":false,"type":"string"}},{"name":"passed","required":false,"in":"query","description":"Filter results based on passed or failed metrics","schema":{"nullable":false,"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScorecardMetricResultDto"}}}}},"404":{"description":"Requested scorecard not found"}},"tags":["Scorecard"]}},"/public/v1/scorecards/{id}":{"put":{"operationId":"ScorecardController_updateScorecardById","summary":"Update an organizational scorecard definition by id.","parameters":[{"name":"id","required":true,"in":"path","description":"Id of scorecard definition to update","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Scorecard metric object to be updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateScorecardDefinitionDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScorecardDto"}}}},"400":{"description":"Returned when request body is not valid"},"404":{"description":"Scorecard is not found"}},"tags":["Scorecard"]},"get":{"operationId":"ScorecardController_getScorecardDefinitionById","summary":"GET an organizational scorecard definition by id.","parameters":[{"name":"id","required":true,"in":"path","description":"Id of scorecard definition to return","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScorecardDto"}}}},"404":{"description":"Scorecard definition is not found"},"422":{"description":""},"502":{"description":""}},"tags":["Scorecard"]}},"/public/v1/module-settings/{id}":{"get":{"operationId":"ModuleSettingsController_getModuleSettingById","summary":"Get a module setting by id.","parameters":[{"name":"id","required":true,"in":"path","description":"Id for given module setting.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleSettingsDto"}}}},"404":{"description":"No module setting found."}},"tags":["Module Settings"]}},"/public/v1/module-settings":{"post":{"operationId":"ModuleSettingsController_createModuleSetting","summary":"Create a module settings object.","parameters":[],"requestBody":{"required":true,"description":"Module settings object to be saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateModuleSettingsDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleSettingsDto"}}}},"404":{"description":""}},"tags":["Module Settings"]}},"/public/v1/sync/services/diff":{"post":{"operationId":"SyncController_getServiceDiff","summary":"Get a diff of services and their dependencies based on the given input","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetServiceDiffDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncServicesResultDto"}}}}},"tags":["Sync"]}},"/public/v1/sync/services":{"post":{"operationId":"SyncController_applyServiceDiff","summary":"Apply a diff of services and their dependencies","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyServiceDiffDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncServicesResultDto"}}}}},"tags":["Sync"]}},"/public/v1/deployments":{"post":{"operationId":"DeploymentController_create","summary":"Create a new deployment entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeploymentDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentDto"}}}},"400":{"description":"Returned when request body is not valid"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden request"},"404":{"description":"Deployment not found"},"500":{"description":"Internal server error"}},"tags":["Deployment"]},"get":{"operationId":"DeploymentController_getDeployments","summary":"GET an organizational list of deployments optionally filtered.","parameters":[{"name":"name","required":false,"in":"query","description":"Filter based on deployment name","schema":{"type":"string"}},{"name":"ownerEmail","required":false,"in":"query","description":"Filter based on owner email","schema":{"type":"string"}},{"name":"repositoryId","required":false,"in":"query","description":"Filter based on deployment repository id","schema":{"type":"string"}},{"name":"environmentId","required":false,"in":"query","description":"Filter based on deployment environment id","schema":{"type":"string"}},{"name":"pageNumber","required":false,"in":"query","description":"Page number to return","schema":{"default":0,"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Number of items to return per page","schema":{"default":20,"type":"number"}},{"name":"sortProperty","required":false,"in":"query","description":"Sort property","schema":{"default":"startedAt","enum":["startedAt","name","createdAt","updatedAt","lastChangedBy","createdBy"],"type":"string"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort order","schema":{"default":"ASC","enum":["ASC","DESC"],"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedResponseDto"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentDto"}}}}]}}}},"400":{"description":"Returned when request query is not valid"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden request"},"500":{"description":"Internal server error"}},"tags":["Deployment"]}},"/public/v1/deployments/{id}":{"patch":{"operationId":"DeploymentController_update","summary":"Update a deployment entity","parameters":[{"name":"id","required":true,"in":"path","description":"ID of the deployment entity.","schema":{}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDeploymentDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentDto"}}}},"400":{"description":"Returned when request body is not valid"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden request"},"404":{"description":"Deployment not found"},"500":{"description":"Internal server error"}},"tags":["Deployment"]},"delete":{"operationId":"DeploymentController_delete","summary":"Delete a deployment entity","parameters":[{"name":"id","required":true,"in":"path","description":"ID of the deployment entity.","schema":{}}],"responses":{"200":{"description":""},"400":{"description":"Returned when request body is not valid"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden request"},"404":{"description":"Deployment not found"},"500":{"description":"Internal server error"}},"tags":["Deployment"]}},"/public/v1/credentials":{"get":{"operationId":"CredentialController_getCredentials","summary":"GET a list of credentials","parameters":[{"name":"searchTerms","required":false,"in":"query","description":"Filter based on credential name","schema":{"type":"string"}},{"name":"providerType","required":false,"in":"query","description":"Filter based on credential provider type","schema":{"type":"string"}},{"name":"providerName","required":false,"in":"query","description":"Filter based on credential provider name","schema":{"type":"string"}},{"name":"pageNumber","required":false,"in":"query","description":"Page number to return","schema":{"default":0,"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Number of items to return per page","schema":{"default":20,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialPageDto"}}}}},"tags":["Credential"]},"post":{"operationId":"CredentialController_createCredential","summary":"POST a new credential","parameters":[],"requestBody":{"required":true,"description":"Credential object to be created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCredentialDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialDto"}}}},"400":{"description":"Returned when request body is not valid"}},"tags":["Credential"]}},"/public/v1/credentials/{id}":{"put":{"operationId":"CredentialController_updateCredential","summary":"PUT a credential","parameters":[{"name":"id","required":true,"in":"path","description":"Id of credential to update","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Credential object to be updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCredentialDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialDto"}}}},"400":{"description":"Returned when request body is not valid"}},"tags":["Credential"]},"delete":{"operationId":"CredentialController_deleteCredential","summary":"DELETE a credential","parameters":[{"name":"id","required":true,"in":"path","description":"Id of credential to delete","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Credential"]}},"/api/v1/scim":{"patch":{"operationId":"ScimController_updateScimConfig","summary":"Update SCIM config","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateScimConfigDto"}}}},"responses":{"200":{"description":""}},"tags":["Private SCIM"],"security":[{"bearer":[]}]},"delete":{"operationId":"ScimController_deleteScimConfig","summary":"Delete SCIM config","parameters":[],"responses":{"200":{"description":""}},"tags":["Private SCIM"],"security":[{"bearer":[]}]},"get":{"operationId":"ScimController_getScimConfig","summary":"Get SCIM config for user's organization","parameters":[],"responses":{"200":{"description":"SCIM config for the user organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimConfigDto"}}}}},"tags":["Private SCIM"],"security":[{"bearer":[]},{"bearer":[]}]}},"/public/v2/scim/Users/{id}":{"get":{"operationId":"SCIMController_getUser","summary":"Get a SCIM user","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMUserDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"403":{"description":"Forbidden request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"404":{"description":"Returned when user is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}}},"tags":["SCIM"],"security":[{"bearer":[]}]},"put":{"operationId":"SCIMController_putUser","summary":"","description":"Update a SCIM user","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMUserDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMUserDto"}}}},"400":{"description":"Returned when request body is not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"403":{"description":"Forbidden request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"404":{"description":"Returned when user is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}}},"tags":["SCIM"],"security":[{"bearer":[]}]},"patch":{"operationId":"SCIMController_patchUser","summary":"Updates a SCIM user status","description":"Patch a SCIM user","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMUserPatchBodyDto"}}}},"responses":{"204":{"description":""},"400":{"description":"Returned when request body is not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"403":{"description":"Forbidden request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"404":{"description":"Returned when user is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}}},"tags":["SCIM"],"security":[{"bearer":[]}]},"delete":{"operationId":"SCIMController_deleteUser","summary":"","description":"Delete a SCIM user","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"204":{"description":""},"400":{"description":"Returned when request can not be processed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"403":{"description":"Forbidden request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"404":{"description":"Returned when user is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}}},"tags":["SCIM"],"security":[{"bearer":[]}]}},"/public/v2/scim/Users":{"get":{"operationId":"SCIMController_getUsers","summary":"Get SCIM users","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMUserListDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"403":{"description":"Forbidden request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}}},"tags":["SCIM"],"security":[{"bearer":[]}]},"post":{"operationId":"SCIMController_createUser","summary":"Create a SCIM user","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMCreateUserDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMUserDto"}}}},"400":{"description":"Returned when request body is not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"403":{"description":"Forbidden request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"409":{"description":"Returned if user already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}}},"tags":["SCIM"],"security":[{"bearer":[]}]}},"/public/v2/scim/Groups":{"get":{"operationId":"SCIMController_getGroups","summary":"Get SCIM group list","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMGroupListDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"403":{"description":"Forbidden request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}}},"tags":["SCIM"],"security":[{"bearer":[]}]},"post":{"operationId":"SCIMController_createGroup","summary":"Create a SCIM group","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMGroupCreateDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMGroupDto"}}}},"400":{"description":"Returned when request body is not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"403":{"description":"Forbidden request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}}},"tags":["SCIM"],"security":[{"bearer":[]}]}},"/public/v2/scim/Groups/{id}":{"get":{"operationId":"SCIMController_getGroup","summary":"Get SCIM group","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMGroupDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"403":{"description":"Forbidden request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"404":{"description":"Returned when group is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}}},"tags":["SCIM"],"security":[{"bearer":[]}]},"put":{"operationId":"SCIMController_putGroup","summary":"Updates group membership or group name","description":"Update a SCIM group","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMGroupUpdateDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMGroupDto"}}}},"400":{"description":"Returned when request body is not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"403":{"description":"Forbidden request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"404":{"description":"Returned when group is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}}},"tags":["SCIM"],"security":[{"bearer":[]}]},"patch":{"operationId":"SCIMController_patchGroup","summary":"","description":"Patch a SCIM group. Supports add, remove, and replace members or replace group name","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMGroupPatchBodyDto"}}}},"responses":{"204":{"description":"Group patched successfully"},"400":{"description":"Returned when request body is not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"403":{"description":"Forbidden request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"404":{"description":"Returned when group is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}}},"tags":["SCIM"],"security":[{"bearer":[]}]},"delete":{"operationId":"SCIMController_deleteGroup","summary":"","description":"Delete a SCIM group","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"204":{"description":""},"400":{"description":"Returned when request can not be processed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"403":{"description":"Forbidden request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"404":{"description":"Returned when group is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}}},"tags":["SCIM"],"security":[{"bearer":[]}]}},"/public/v2/scim/ServiceProviderConfig":{"get":{"operationId":"SCIMController_getServiceProviderConfig","summary":"Get SCIM service provider configuration","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimSchemaServiceProviderConfigDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"403":{"description":"Forbidden request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}}},"tags":["SCIM"],"security":[{"bearer":[]}]}},"/public/v2/scim/ResourceTypes":{"get":{"operationId":"SCIMController_getResourceTypes","summary":"Get SCIM ResourceTypes schema","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimResourceTypeDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"403":{"description":"Forbidden request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}}},"tags":["SCIM"],"security":[{"bearer":[]}]}},"/public/v2/scim/Schemas":{"get":{"operationId":"SCIMController_getSchemas","summary":"Get array of all SCIM SCHEMAS","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ScimSchemaUserDto"},{"$ref":"#/components/schemas/ScimSchemaGroupDto"},{"$ref":"#/components/schemas/ScimSchemaServiceProviderConfigDto"},{"type":"array","items":{"$ref":"#/components/schemas/ScimResourceTypeDto"}}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"403":{"description":"Forbidden request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}}},"tags":["SCIM"],"security":[{"bearer":[]}]}},"/public/v2/scim/Schemas/{schema}":{"get":{"operationId":"SCIMController_getSchema","summary":"Get SCIM schema by schema id","parameters":[{"name":"schema","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ScimSchemaUserDto"},{"$ref":"#/components/schemas/ScimSchemaGroupDto"},{"$ref":"#/components/schemas/ScimSchemaServiceProviderConfigDto"},{"type":"array","items":{"$ref":"#/components/schemas/ScimResourceTypeDto"}}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}},"403":{"description":"Forbidden request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SCIMErrorDto"}}}}},"tags":["SCIM"],"security":[{"bearer":[]}]}}},"info":{"title":"C8 Public API","description":"Documentation for C8 Public API","version":"1.0.0","contact":{}},"tags":[{"name":"C8","description":""}],"servers":[],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"Api-Key"},"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CatalogSimplePropertyFilter":{"type":"object","properties":{"filterType":{"type":"string","description":"Filter type","enum":["SIMPLE"]},"name":{"type":"string","description":"Property to filter by","enum":["id","name","description","type","provider","providerResourceKey","providerResourceType","providerAccountId"]},"value":{"type":"string","description":"Property value"}},"required":["filterType","name","value"]},"CatalogPropertyPublicFilter":{"type":"object","properties":{"name":{"type":"string","description":"Property to filter by","enum":["id","name","description","type","provider","providerResourceKey","providerResourceType","providerAccountId"]},"value":{"type":"string","description":"Property value"}},"required":["name","value"]},"CatalogCompoundPropertyFilter":{"type":"object","properties":{"filterType":{"type":"string","description":"Filter type","enum":["COMPOUND"]},"operand":{"type":"string","description":"Operand","enum":["AND","OR"]},"propertyFilters":{"description":"Property filters","type":"array","items":{"$ref":"#/components/schemas/CatalogPropertyPublicFilter"}}},"required":["filterType","operand","propertyFilters"]},"CatalogEntitySort":{"type":"object","properties":{"property":{"type":"string","description":"Property to sort by"},"order":{"type":"string","description":"Sort order","enum":["ASC","DESC"]}},"required":["property","order"]},"CatalogEntityQueryDto":{"type":"object","properties":{"propertyFilters":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/CatalogSimplePropertyFilter"},{"$ref":"#/components/schemas/CatalogCompoundPropertyFilter"}]},"description":"Filters for matching properties' values:\n    Can be SIMPLE and COMPOUND.\n    SIMPLE is a key-value pair.\n    COMPOUND is a set of key-value pairs combined with OR or AND operator"},"searchTerms":{"type":"string","description":"Term to search by"},"searchOnlyByName":{"type":"boolean","default":false,"description":"Perform search only by entity name. By default search will be performed considering all text properties"},"types":{"type":"array","description":"Catalog entity types to filter by","items":{"type":"string","enum":["application","system","service","resource","environment","person","api","repository","library","manifest","team","base"]}},"includeProperties":{"description":"Entity properties that will be returned in result. \n  By default all entity properties are included in response. \n  If includeProperties is passed, regardless of which properties are specified, 'id' and 'type' fields will be always included","type":"array","items":{"type":"string"}},"pageNumber":{"type":"number","default":0},"pageSize":{"type":"number","default":20},"sort":{"description":"Sort entities by property in ASC or DESC order","allOf":[{"$ref":"#/components/schemas/CatalogEntitySort"}]}}},"MetadataTagDto":{"type":"object","properties":{"name":{"type":"string","description":"Metadata tag's name"},"value":{"type":"string","description":"Metadata tag's value"},"type":{"type":"string","enum":["JSON","Code","Link","Text","AutoMap","Nickname"],"description":"Metadata tag's type"},"createdBy":{"type":"string","enum":["MANUAL","SYSTEM"],"description":"Metadata tag's createdBy strategy","nullable":true}},"required":["name","value","type"]},"MetadataLinkDto":{"type":"object","properties":{"url":{"type":"string","description":"Link url"},"title":{"type":"string","description":"Link title"},"icon":{"type":"string","description":"Link icon"}},"required":["url","title","icon"]},"EntityParentDto":{"type":"object","properties":{"id":{"type":"string","description":"Parent entity id"},"secondaryId":{"type":"string","description":"Service id, used only in Environment-Resource relation (label 'contains')"},"label":{"type":"string","enum":["belongs_to","depends_on","provides","has_environment","part_of","consumes","uses","contains","has_repository","has_library","has_manifest","has_dependency","child_of","relative_to",""],"description":"Entity relation type"},"field":{"type":"string","description":"Entity relation field"}},"required":["id","secondaryId","label","field"]},"CatalogEntityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"orgId":{"type":"string"},"type":{"type":"string","enum":["application","system","service","resource","environment","person","api","repository","library","manifest","team","base"],"description":"Catalog entity type"},"description":{"type":"string","description":"Catalog entity description"},"tags":{"description":"Catalog entity's tags","type":"array","items":{"type":"string"}},"metaTags":{"description":"Catalog entity's metadata","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"links":{"description":"Catalog entity's links","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"parents":{"description":"Catalog entity's parents","type":"array","items":{"$ref":"#/components/schemas/EntityParentDto"}},"createdBy":{"type":"string"},"lastChangedBy":{"type":"string"},"createDateTime":{"format":"date-time","type":"string"},"lastChangedDateTime":{"format":"date-time","type":"string"},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}}},"required":["id","name","orgId","type"]},"CatalogEntitiesSearchResultDto":{"type":"object","properties":{"totalFound":{"type":"number","description":"Total elements found"},"pageNumber":{"type":"number"},"pageSize":{"type":"number"},"items":{"description":"Found catalog entities","type":"array","items":{"$ref":"#/components/schemas/CatalogEntityDto"}}},"required":["totalFound","pageNumber","pageSize","items"]},"CreateCatalogPersonDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entity"},"description":{"type":"string","description":"Description of the entity"},"tags":{"description":"Tags to add to the entity","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"email":{"type":"string","description":"The email of this person"},"userId":{"type":"string","description":"The ID of the user linked to this person"},"photoUrl":{"type":"string","description":"An optional URL of a photo/image to display for this person"},"familyName":{"type":"string","description":"User family name"},"givenName":{"type":"string","description":"User given name"},"externalId":{"type":"string","description":"User external id"}},"required":["name","email"]},"UpdateCatalogResourceDto":{"type":"object","properties":{"name":{"type":"string","description":"Catalog entity name, should be unique, not updatable for discovery created catalog entity"},"description":{"type":"string","description":"Catalog entity description, not updatable for discovery created catalog entity"},"tags":{"description":"Tags to add to the entity, replaces the existing list","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"permissionsPatterns":{"type":"array","items":{"type":"string"}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"providerResourceKey":{"type":"string","description":"The key/ID of the resource in the provider","example":"123456789012"},"providerAccountId":{"type":"string","description":"The key/ID of the account that owns this resource"},"location":{"type":"string","description":"Resource location"},"details":{"type":"object","description":"Resource details in json format"},"parents":{"description":"Catalog resource's parents, replaces the existing parents list","type":"array","items":{"$ref":"#/components/schemas/EntityParentDto"}},"deepLinkUrl":{"type":"string","description":"Deep link to the resource"}}},"CatalogResourceDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"orgId":{"type":"string"},"type":{"type":"string","enum":["application","system","service","resource","environment","person","api","repository","library","manifest","team","base"],"description":"Catalog entity type"},"description":{"type":"string","description":"Catalog entity description"},"tags":{"description":"Catalog entity's tags","type":"array","items":{"type":"string"}},"metaTags":{"description":"Catalog entity's metadata","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"links":{"description":"Catalog entity's links","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"parents":{"description":"Catalog entity's parents","type":"array","items":{"$ref":"#/components/schemas/EntityParentDto"}},"createdBy":{"type":"string"},"lastChangedBy":{"type":"string"},"createDateTime":{"format":"date-time","type":"string"},"lastChangedDateTime":{"format":"date-time","type":"string"},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"provider":{"type":"string"},"providerType":{"type":"string"},"providerResourceKey":{"type":"string"},"providerResourceType":{"type":"string"},"providerAccountId":{"type":"string"},"location":{"type":"string"},"details":{"type":"object"},"deepLinkUrl":{"type":"string"}},"required":["id","name","orgId","type","provider","providerType","providerResourceKey","providerResourceType","providerAccountId","location"]},"UpdateCatalogServiceDto":{"type":"object","properties":{"name":{"type":"string","description":"Catalog entity name, should be unique, not updatable for discovery created catalog entity"},"description":{"type":"string","description":"Catalog entity description, not updatable for discovery created catalog entity"},"tags":{"description":"Tags to add to the entity, replaces the existing list","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"permissionsPatterns":{"type":"array","items":{"type":"string"}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"repositoryPath":{"type":"string","description":"The path of the repository"},"languages":{"description":"The languages that this service uses","type":"array","items":{"type":"string"}},"lifecycle":{"type":"string","description":"The lifecycle of the service"},"templateId":{"type":"string","description":"The ID of the template that this service is based on"}}},"CatalogServiceDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"orgId":{"type":"string"},"type":{"type":"string","enum":["application","system","service","resource","environment","person","api","repository","library","manifest","team","base"],"description":"Catalog entity type"},"description":{"type":"string","description":"Catalog entity description"},"tags":{"description":"Catalog entity's tags","type":"array","items":{"type":"string"}},"metaTags":{"description":"Catalog entity's metadata","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"links":{"description":"Catalog entity's links","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"parents":{"description":"Catalog entity's parents","type":"array","items":{"$ref":"#/components/schemas/EntityParentDto"}},"createdBy":{"type":"string"},"lastChangedBy":{"type":"string"},"createDateTime":{"format":"date-time","type":"string"},"lastChangedDateTime":{"format":"date-time","type":"string"},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"repositoryPath":{"type":"string"},"languages":{"type":"array","items":{"type":"string"}},"lifecycle":{"type":"string"}},"required":["id","name","orgId","type"]},"UpdateCatalogPersonDto":{"type":"object","properties":{"name":{"type":"string","description":"Catalog entity name, should be unique, not updatable for discovery created catalog entity"},"description":{"type":"string","description":"Catalog entity description, not updatable for discovery created catalog entity"},"tags":{"description":"Tags to add to the entity, replaces the existing list","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"permissionsPatterns":{"type":"array","items":{"type":"string"}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"photoUrl":{"type":"string","description":"Person photo url"},"familyName":{"type":"string","description":"Person family name"},"givenName":{"type":"string","description":"Person givenName name"}}},"CatalogPersonDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"orgId":{"type":"string"},"type":{"type":"string","enum":["application","system","service","resource","environment","person","api","repository","library","manifest","team","base"],"description":"Catalog entity type"},"description":{"type":"string","description":"Catalog entity description"},"tags":{"description":"Catalog entity's tags","type":"array","items":{"type":"string"}},"metaTags":{"description":"Catalog entity's metadata","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"links":{"description":"Catalog entity's links","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"parents":{"description":"Catalog entity's parents","type":"array","items":{"$ref":"#/components/schemas/EntityParentDto"}},"createdBy":{"type":"string"},"lastChangedBy":{"type":"string"},"createDateTime":{"format":"date-time","type":"string"},"lastChangedDateTime":{"format":"date-time","type":"string"},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"email":{"type":"string"},"isActive":{"type":"boolean"},"userId":{"type":"string"},"externalId":{"type":"string"},"familyName":{"type":"string"},"givenName":{"type":"string"},"photoUrl":{"type":"string"},"provisioned":{"type":"boolean"}},"required":["id","name","orgId","type","email","isActive"]},"CreateCatalogResourceDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entity"},"description":{"type":"string","description":"Description of the entity"},"tags":{"description":"Tags to add to the entity","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"providerResourceKey":{"type":"string","description":"The key/ID of the resource in the provider","example":"123456789012"},"provider":{"type":"string","description":"Provider name"},"providerResourceType":{"type":"string","description":"Provider resource type"},"providerAccountId":{"type":"string","description":"The key/ID of the account that owns this resource"},"location":{"type":"string","description":"Resource location"},"details":{"type":"object","description":"Resource details in json format"},"parents":{"description":"Catalog resource's parents","type":"array","items":{"$ref":"#/components/schemas/EntityParentDto"}},"deepLinkUrl":{"type":"string","description":"Deep link to the resource"}},"required":["name","providerResourceKey","provider","providerResourceType"]},"CreateCatalogLibraryDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entity"},"description":{"type":"string","description":"Description of the entity"},"tags":{"description":"Tags to add to the entity","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"requirements":{"type":"string","description":"The version requirements for this library","example":"= 1.1"},"provider":{"type":"string","description":"The provider of the repository where the library resides"},"providerResourceKey":{"type":"string","description":"The key/ID of this library in the provider"},"packageManager":{"type":"string","description":"The package manager of this library","example":"ACTIONS","enum":["ACTIONS","NPM","PIP","MAVEN","GRADLE","GO"]},"packageLabel":{"type":"string","description":"The label of this library. Defaults to the name of the entity"}},"required":["name","provider","packageManager"]},"CatalogLibraryDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"orgId":{"type":"string"},"type":{"type":"string","enum":["application","system","service","resource","environment","person","api","repository","library","manifest","team","base"],"description":"Catalog entity type"},"description":{"type":"string","description":"Catalog entity description"},"tags":{"description":"Catalog entity's tags","type":"array","items":{"type":"string"}},"metaTags":{"description":"Catalog entity's metadata","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"links":{"description":"Catalog entity's links","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"parents":{"description":"Catalog entity's parents","type":"array","items":{"$ref":"#/components/schemas/EntityParentDto"}},"createdBy":{"type":"string"},"lastChangedBy":{"type":"string"},"createDateTime":{"format":"date-time","type":"string"},"lastChangedDateTime":{"format":"date-time","type":"string"},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"requirements":{"type":"string"},"provider":{"type":"string"},"providerType":{"type":"string"},"providerResourceKey":{"type":"string"},"providerResourceType":{"type":"string"},"packageName":{"type":"string"},"packageManager":{"type":"string"},"packageLabel":{"type":"string"}},"required":["id","name","orgId","type","requirements","provider","providerType","providerResourceKey","providerResourceType","packageName","packageManager"]},"RepositoryContributorDto":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the contributor"},"login":{"type":"string","description":"The display name of the contributor"},"contributions":{"type":"number","description":"The number of lines this contributor added"}},"required":["id","login"]},"RepositoryLanguageDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the language"},"lines":{"type":"number","description":"The number of lines written in this language "},"percent":{"type":"number","description":"The percentage of the code written in this language"}},"required":["name","lines","percent"]},"RepositoryReleaseDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of this release"},"date":{"type":"string","description":"The date this release was made as an ISO 8601 string"},"tag":{"type":"string","description":"The tag associated with this release"},"latest":{"type":"boolean","description":"True if this is the latest release, false otherwise"}},"required":["name","date","tag","latest"]},"CreateCatalogRepositoryDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entity"},"description":{"type":"string","description":"Description of the entity"},"tags":{"description":"Tags to add to the entity","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"url":{"type":"string","description":"The URL of the repository"},"contributors":{"description":"The list of constributors for this repository","type":"array","items":{"$ref":"#/components/schemas/RepositoryContributorDto"}},"languages":{"description":"The languages that this repository uses","type":"array","items":{"$ref":"#/components/schemas/RepositoryLanguageDto"}},"release":{"description":"The latest release of this repository","allOf":[{"$ref":"#/components/schemas/RepositoryReleaseDto"}]},"provider":{"type":"string","description":"The provider of this repository","enum":["GitHub","Bitbucket","GitLab","Azure DevOps"]},"providerResourceKey":{"type":"string","description":"The key/ID of this repository in the provider"},"providerAccountId":{"type":"string","description":"The key/ID of the account that owns this repository"},"location":{"type":"string","description":"The full path of the repository"}},"required":["name","url","provider","providerResourceKey","providerAccountId","location"]},"CatalogRepositoryDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"orgId":{"type":"string"},"type":{"type":"string","enum":["application","system","service","resource","environment","person","api","repository","library","manifest","team","base"],"description":"Catalog entity type"},"description":{"type":"string","description":"Catalog entity description"},"tags":{"description":"Catalog entity's tags","type":"array","items":{"type":"string"}},"metaTags":{"description":"Catalog entity's metadata","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"links":{"description":"Catalog entity's links","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"parents":{"description":"Catalog entity's parents","type":"array","items":{"$ref":"#/components/schemas/EntityParentDto"}},"createdBy":{"type":"string"},"lastChangedBy":{"type":"string"},"createDateTime":{"format":"date-time","type":"string"},"lastChangedDateTime":{"format":"date-time","type":"string"},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"url":{"type":"string"},"contributors":{"type":"array","items":{"type":"string"}},"languages":{"type":"array","items":{"type":"string"}},"release":{"$ref":"#/components/schemas/RepositoryReleaseDto"},"provider":{"type":"string"},"providerType":{"type":"string"},"providerResourceKey":{"type":"string"},"providerResourceType":{"type":"string"},"providerAccountId":{"type":"string"},"location":{"type":"string"},"details":{"type":"object"}},"required":["id","name","orgId","type","url","contributors","languages","release","provider","providerType","providerResourceKey","providerResourceType","providerAccountId","location"]},"UpdateCatalogRepositoryDto":{"type":"object","properties":{"name":{"type":"string","description":"Catalog entity name, should be unique, not updatable for discovery created catalog entity"},"description":{"type":"string","description":"Catalog entity description, not updatable for discovery created catalog entity"},"tags":{"description":"Tags to add to the entity, replaces the existing list","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"permissionsPatterns":{"type":"array","items":{"type":"string"}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"url":{"type":"string","description":"The URL of the repository"},"contributors":{"description":"The list of contributors for this repository","type":"array","items":{"$ref":"#/components/schemas/RepositoryContributorDto"}},"languages":{"description":"The languages that this repository uses","type":"array","items":{"$ref":"#/components/schemas/RepositoryLanguageDto"}},"release":{"description":"The latest release of this repository","allOf":[{"$ref":"#/components/schemas/RepositoryReleaseDto"}]},"provider":{"type":"string","description":"The provider of this repository","enum":["GitHub","Bitbucket","GitLab","Azure DevOps"]},"providerResourceKey":{"type":"string","description":"The key/ID of this repository in the provider"},"providerAccountId":{"type":"string","description":"The key/ID of the account that owns this repository"},"location":{"type":"string","description":"The full path of the repository"}},"required":["provider"]},"CreateCatalogEnvironmentDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entity"},"description":{"type":"string","description":"Description of the entity"},"tags":{"description":"Tags to add to the entity","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}}},"required":["name"]},"CatalogEnvironmentDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"orgId":{"type":"string"},"type":{"type":"string","enum":["application","system","service","resource","environment","person","api","repository","library","manifest","team","base"],"description":"Catalog entity type"},"description":{"type":"string","description":"Catalog entity description"},"tags":{"description":"Catalog entity's tags","type":"array","items":{"type":"string"}},"metaTags":{"description":"Catalog entity's metadata","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"links":{"description":"Catalog entity's links","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"parents":{"description":"Catalog entity's parents","type":"array","items":{"$ref":"#/components/schemas/EntityParentDto"}},"createdBy":{"type":"string"},"lastChangedBy":{"type":"string"},"createDateTime":{"format":"date-time","type":"string"},"lastChangedDateTime":{"format":"date-time","type":"string"},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}}},"required":["id","name","orgId","type"]},"CreateCatalogServiceDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entity"},"description":{"type":"string","description":"Description of the entity"},"tags":{"description":"Tags to add to the entity","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"repositoryId":{"type":"string","description":"The ID of the repository entity to assign to the service"},"repositoryPath":{"type":"string","description":"The path of the repository"},"languages":{"description":"The languages that this service uses","type":"array","items":{"type":"string"}},"lifecycle":{"type":"string","description":"The lifecycle of the service"},"applications":{"description":"The ID of the application entities linked to this service","type":"array","items":{"type":"string"}},"templateId":{"type":"string","description":"The ID of the template that this entity is based on"}},"required":["name"]},"CreateCatalogSystemDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entity"},"description":{"type":"string","description":"Description of the entity"},"tags":{"description":"Tags to add to the entity","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}}},"required":["name"]},"CatalogSystemDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"orgId":{"type":"string"},"type":{"type":"string","enum":["application","system","service","resource","environment","person","api","repository","library","manifest","team","base"],"description":"Catalog entity type"},"description":{"type":"string","description":"Catalog entity description"},"tags":{"description":"Catalog entity's tags","type":"array","items":{"type":"string"}},"metaTags":{"description":"Catalog entity's metadata","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"links":{"description":"Catalog entity's links","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"parents":{"description":"Catalog entity's parents","type":"array","items":{"$ref":"#/components/schemas/EntityParentDto"}},"createdBy":{"type":"string"},"lastChangedBy":{"type":"string"},"createDateTime":{"format":"date-time","type":"string"},"lastChangedDateTime":{"format":"date-time","type":"string"},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}}},"required":["id","name","orgId","type"]},"CreateCatalogApplicationDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entity"},"description":{"type":"string","description":"Description of the entity"},"tags":{"description":"Tags to add to the entity","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}}},"required":["name"]},"CatalogApplicationDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"orgId":{"type":"string"},"type":{"type":"string","enum":["application","system","service","resource","environment","person","api","repository","library","manifest","team","base"],"description":"Catalog entity type"},"description":{"type":"string","description":"Catalog entity description"},"tags":{"description":"Catalog entity's tags","type":"array","items":{"type":"string"}},"metaTags":{"description":"Catalog entity's metadata","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"links":{"description":"Catalog entity's links","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"parents":{"description":"Catalog entity's parents","type":"array","items":{"$ref":"#/components/schemas/EntityParentDto"}},"createdBy":{"type":"string"},"lastChangedBy":{"type":"string"},"createDateTime":{"format":"date-time","type":"string"},"lastChangedDateTime":{"format":"date-time","type":"string"},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}}},"required":["id","name","orgId","type"]},"UpdateCatalogApplicationDto":{"type":"object","properties":{"name":{"type":"string","description":"Catalog entity name, should be unique, not updatable for discovery created catalog entity"},"description":{"type":"string","description":"Catalog entity description, not updatable for discovery created catalog entity"},"tags":{"description":"Tags to add to the entity, replaces the existing list","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"permissionsPatterns":{"type":"array","items":{"type":"string"}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}}}},"CreateCatalogManifestDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entity"},"description":{"type":"string","description":"Description of the entity"},"tags":{"description":"Tags to add to the entity","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"repoPath":{"type":"string","description":"The path of this manifest in the repository"},"totalDependencies":{"type":"number","description":"The total amount of dependencies that this manifest has"},"provider":{"type":"string","description":"The provider of the repository where the manifest resides","enum":["GitHub","Bitbucket","GitLab","Azure DevOps"]},"providerResourceKey":{"type":"string","description":"The key/ID of this manifest. Typically the path of the file containing dependencies","example":"some/path/package.json"},"providerAccountId":{"type":"string","description":"The key/ID of the account that owns this manifest"}},"required":["name","repoPath","provider","providerResourceKey","providerAccountId"]},"CatalogManifestDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"orgId":{"type":"string"},"type":{"type":"string","enum":["application","system","service","resource","environment","person","api","repository","library","manifest","team","base"],"description":"Catalog entity type"},"description":{"type":"string","description":"Catalog entity description"},"tags":{"description":"Catalog entity's tags","type":"array","items":{"type":"string"}},"metaTags":{"description":"Catalog entity's metadata","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"links":{"description":"Catalog entity's links","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"parents":{"description":"Catalog entity's parents","type":"array","items":{"$ref":"#/components/schemas/EntityParentDto"}},"createdBy":{"type":"string"},"lastChangedBy":{"type":"string"},"createDateTime":{"format":"date-time","type":"string"},"lastChangedDateTime":{"format":"date-time","type":"string"},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"repoPath":{"type":"string"},"totalDependencies":{"type":"number"},"provider":{"type":"string"},"providerType":{"type":"string"},"providerResourceKey":{"type":"string"},"providerResourceType":{"type":"string"},"providerAccountId":{"type":"string"}},"required":["id","name","orgId","type","repoPath","totalDependencies","provider","providerType","providerResourceKey","providerResourceType","providerAccountId"]},"UpdateCatalogEnvironmentDto":{"type":"object","properties":{"name":{"type":"string","description":"Catalog entity name, should be unique, not updatable for discovery created catalog entity"},"description":{"type":"string","description":"Catalog entity description, not updatable for discovery created catalog entity"},"tags":{"description":"Tags to add to the entity, replaces the existing list","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"permissionsPatterns":{"type":"array","items":{"type":"string"}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}}}},"UpdateCatalogManifestDto":{"type":"object","properties":{"name":{"type":"string","description":"Catalog entity name, should be unique, not updatable for discovery created catalog entity"},"description":{"type":"string","description":"Catalog entity description, not updatable for discovery created catalog entity"},"tags":{"description":"Tags to add to the entity, replaces the existing list","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"permissionsPatterns":{"type":"array","items":{"type":"string"}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"repoPath":{"type":"string","description":"The path of this manifest in the repository"},"totalDependencies":{"type":"number","description":"The total amount of dependencies that this manifest has"},"provider":{"type":"string","description":"The provider of the repository where the manifest resides","enum":["GitHub","Bitbucket","GitLab","Azure DevOps"]},"providerResourceKey":{"type":"string","description":"The key/ID of this manifest. Typically the path of the file containing dependencies","example":"some/path/package.json"},"providerAccountId":{"type":"string","description":"The key/ID of the account that owns this manifest"}}},"UpdateCatalogSystemDto":{"type":"object","properties":{"name":{"type":"string","description":"Catalog entity name, should be unique, not updatable for discovery created catalog entity"},"description":{"type":"string","description":"Catalog entity description, not updatable for discovery created catalog entity"},"tags":{"description":"Tags to add to the entity, replaces the existing list","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"permissionsPatterns":{"type":"array","items":{"type":"string"}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}}}},"UpdateCatalogLibraryDto":{"type":"object","properties":{"name":{"type":"string","description":"Catalog entity name, should be unique, not updatable for discovery created catalog entity"},"description":{"type":"string","description":"Catalog entity description, not updatable for discovery created catalog entity"},"tags":{"description":"Tags to add to the entity, replaces the existing list","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"permissionsPatterns":{"type":"array","items":{"type":"string"}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"requirements":{"type":"string","description":"The version requirements for this library","example":"> 2.2"},"provider":{"type":"string","description":"The provider of the repository where the library resides"},"providerResourceKey":{"type":"string","description":"The key/ID of this library in the provider"},"packageManager":{"type":"string","description":"The package manager of this library","example":"GO","enum":["ACTIONS","NPM","PIP","MAVEN","GRADLE","GO"]},"packageLabel":{"type":"string","description":"The label of this library. Defaults to the name of the entity"}},"required":["packageManager"]},"CreateCatalogBaseDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entity"},"description":{"type":"string","description":"Description of the entity"},"tags":{"description":"Tags to add to the entity","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"providerResourceType":{"type":"string","description":"Provider resource type"},"details":{"type":"object","description":"Resource details in json format"},"parents":{"description":"Catalog resource's parents","type":"array","items":{"$ref":"#/components/schemas/EntityParentDto"}}},"required":["name","providerResourceType"]},"CatalogBaseDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"orgId":{"type":"string"},"type":{"type":"string","enum":["application","system","service","resource","environment","person","api","repository","library","manifest","team","base"],"description":"Catalog entity type"},"description":{"type":"string","description":"Catalog entity description"},"tags":{"description":"Catalog entity's tags","type":"array","items":{"type":"string"}},"metaTags":{"description":"Catalog entity's metadata","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"links":{"description":"Catalog entity's links","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"parents":{"description":"Catalog entity's parents","type":"array","items":{"$ref":"#/components/schemas/EntityParentDto"}},"createdBy":{"type":"string"},"lastChangedBy":{"type":"string"},"createDateTime":{"format":"date-time","type":"string"},"lastChangedDateTime":{"format":"date-time","type":"string"},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"providerResourceType":{"type":"string"},"details":{"type":"object"}},"required":["id","name","orgId","type","providerResourceType"]},"UpdateCatalogBaseDto":{"type":"object","properties":{"name":{"type":"string","description":"Catalog entity name, should be unique, not updatable for discovery created catalog entity"},"description":{"type":"string","description":"Catalog entity description, not updatable for discovery created catalog entity"},"tags":{"description":"Tags to add to the entity, replaces the existing list","type":"array","items":{"type":"string"}},"links":{"description":"List of URLs linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataLinkDto"}},"metaTags":{"description":"List of metadata tags linked to this entity, replaces the existing list","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}},"permissions":{"type":"object","description":"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, \n    and the value is array of the permissions associated with each user or team.","additionalProperties":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}}},"permissionsPatterns":{"type":"array","items":{"type":"string"}},"generalAccess":{"type":"array","description":"Entity visibility control. By default it is set to a default access control on organization level","nullable":false,"items":{"type":"string","enum":["read","inherit"]}},"details":{"type":"object","description":"Base details in json format"},"parents":{"description":"Catalog resource's parents, replaces the existing parents list","type":"array","items":{"$ref":"#/components/schemas/EntityParentDto"}}}},"FailedResource":{"type":"object","properties":{"providerResourceKey":{"type":"string","description":"Provider resource key"},"status":{"type":"number","description":"Status of failed creation"},"error":{"type":"string","description":"Error message"}},"required":["providerResourceKey","status","error"]},"CreateCatalogResourceBatchResultDto":{"type":"object","properties":{"success":{"type":"number","description":"Number of successfully saved entities"},"failures":{"type":"number","description":"Number of entities that failed saving"},"items":{"description":"Created resources","type":"array","items":{"$ref":"#/components/schemas/CatalogResourceDto"}},"failed":{"description":"Failed resources","type":"array","items":{"$ref":"#/components/schemas/FailedResource"}}},"required":["success","failures","items","failed"]},"DeleteCatalogEntitiesBatchDto":{"type":"object","properties":{"ids":{"description":"Ids of entities to delete","type":"array","items":{"type":"string"}}},"required":["ids"]},"DeleteCatalogEntitiesBatchResultDto":{"type":"object","properties":{"deleted":{"type":"number","description":"Number of deleted entities"}},"required":["deleted"]},"CatalogRelationDto":{"type":"object","properties":{"sourceEntityId":{"type":"string"},"targetEntityId":{"type":"string"},"label":{"type":"string","description":"Entity relation type","enum":["belongs_to","depends_on","provides","has_environment","part_of","consumes","uses","contains","has_repository","has_library","has_manifest","has_dependency","child_of","relative_to",""]},"field":{"type":"string","description":"Entity relation field"}},"required":["sourceEntityId","targetEntityId","label"]},"CatalogRelationResultDto":{"type":"object","properties":{"totalFound":{"type":"number","description":"Total elements found"},"pageNumber":{"type":"number"},"pageSize":{"type":"number"},"items":{"description":"Found catalog entities","type":"array","items":{"$ref":"#/components/schemas/CatalogRelationDto"}}},"required":["totalFound","pageNumber","pageSize","items"]},"CreateCatalogRelationDto":{"type":"object","properties":{"serviceId":{"type":"string","description":"Service id as an additional relation parameter. Used ONLY when creating Environment-Resource relation"},"sourceEntityId":{"type":"string","description":"Id of the entity from which we want to create a relation"},"targetEntityId":{"type":"string","description":"Id of the entity to which we want to create a relation"},"label":{"type":"string","enum":["belongs_to","depends_on","provides","has_environment","part_of","consumes","uses","contains","has_repository","has_library","has_manifest","has_dependency","child_of","relative_to",""],"description":"Entity relation type"},"field":{"type":"string","description":"Entity relation field"}},"required":["sourceEntityId","targetEntityId","label"]},"DeleteCatalogRelationDto":{"type":"object","properties":{"serviceId":{"type":"string","description":"Catalog relation service id"},"sourceEntityId":{"type":"string","description":"Catalog Source entity id"},"targetEntityId":{"type":"string","description":"Catalog Target entity id"},"field":{"type":"string","description":"Entity relation field"}},"required":["sourceEntityId","targetEntityId"]},"CatalogEntityMetadataDto":{"type":"object","properties":{"id":{"type":"string"},"orgId":{"type":"string"},"type":{"type":"string","enum":["application","system","service","resource","environment","person","api","repository","library","manifest","team","base"],"description":"Catalog entity type"},"metaTags":{"description":"Catalog entity's metadata","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}}},"required":["id","orgId","type"]},"CatalogEntityMetadataUpdateDto":{"type":"object","properties":{"metaTags":{"description":"Catalog entity's metadata","type":"array","items":{"$ref":"#/components/schemas/MetadataTagDto"}}}},"TemplateAttributeDto":{"type":"object","properties":{"name":{"type":"string","description":"Template attribute name"},"description":{"type":"string","description":"Template attribute description"},"displayName":{"type":"string","description":"Template attribute display name"},"attributeType":{"type":"string","enum":["string","number","array","multiline_string"],"description":"Template attribute type"},"optional":{"type":"boolean","description":"Is this attribute required or not"}},"required":["name","displayName","attributeType","optional"]},"TemplateFormSectionDto":{"type":"object","properties":{"title":{"type":"string","description":"Section title"},"description":{"type":"string","description":"Section description"},"attributes":{"description":"Attributes","type":"array","items":{"$ref":"#/components/schemas/TemplateAttributeDto"}}},"required":["title","description","attributes"]},"TemplateFormDto":{"type":"object","properties":{"sections":{"description":"Template form sections","type":"array","items":{"$ref":"#/components/schemas/TemplateFormSectionDto"}}},"required":["sections"]},"TemplateDefinitionDto":{"type":"object","properties":{"entityType":{"type":"string","enum":["application","system","service","resource","environment","person","api","repository","library","manifest","team","base"],"description":"Template definition entityType"},"form":{"description":"Template definition form","allOf":[{"$ref":"#/components/schemas/TemplateFormDto"}]}},"required":["entityType","form"]},"TemplateDto":{"type":"object","properties":{"id":{"type":"string","description":"Template id"},"orgId":{"type":"string","description":"Template orgId"},"name":{"type":"string","description":"Template name"},"description":{"type":"string","description":"Template description"},"type":{"type":"string","description":"Template type","enum":["core","user"]},"category":{"type":"string","description":"Template category","enum":["create","display"]},"icon":{"type":"string","description":"Template icon"},"definition":{"description":"Template definition","allOf":[{"$ref":"#/components/schemas/TemplateDefinitionDto"}]},"createdBy":{"type":"string","description":"Template createdBy"},"createdAt":{"format":"date-time","type":"string","description":"Template createdAt"},"updatedAt":{"format":"date-time","type":"string","description":"Template updatedAt"},"lastChangedBy":{"type":"string","description":"Template last changed by id"}},"required":["id","orgId","name","description","type","category","definition","createdBy","createdAt","updatedAt","lastChangedBy"]},"UpdateUserDto":{"type":"object","properties":{"firstName":{"type":"string","description":"User first name"},"lastName":{"type":"string","description":"User last name"},"displayName":{"type":"string","description":"User display name"},"photoUrl":{"type":"string","description":"User avatar url"},"status":{"type":"string","description":"User status","enum":["INVITED","UNVERIFIED","ACTIVE","DISABLED"]},"role":{"type":"string","description":"User role","enum":["USER","ADMIN"]}}},"UserDto":{"type":"object","properties":{"id":{"type":"string","description":"User id"},"email":{"type":"string","description":"User email"},"orgId":{"type":"string","description":"User organization id"},"firstName":{"type":"string","description":"User first name"},"lastName":{"type":"string","description":"User last name"},"displayName":{"type":"string","description":"User display name"},"status":{"type":"string","enum":["INVITED","UNVERIFIED","ACTIVE","DISABLED"],"description":"User status"},"role":{"type":"string","enum":["USER","ADMIN"],"description":"User role"},"photoUrl":{"type":"string","description":"User avatar url"},"acceptedTermsOfServiceAndPrivacyPolicyAt":{"format":"date-time","type":"string","description":"Identifier for when user accepted terms of service and privacy policy"},"lastChangedBy":{"type":"string","description":"Who last changed this user info"},"lastLoginAt":{"format":"date-time","type":"string","description":"Last user login date"},"provisioned":{"type":"boolean","description":"Indificates if user created with SCIM"}},"required":["id","email","orgId","status","role"]},"User":{"type":"object","properties":{}},"UsersPageDto":{"type":"object","properties":{"items":{"description":"List of users","type":"array","items":{"$ref":"#/components/schemas/User"}},"totalFound":{"type":"number","description":"Total users found by this endpoint call"},"pageSize":{"type":"number","description":"Maximum users in one paginated response"},"pageNumber":{"type":"number","description":"Requested page, note that it starts with 0"}},"required":["items","totalFound","pageSize","pageNumber"]},"ScheduleDto":{"type":"object","properties":{"id":{"type":"string","description":"Schedule id"},"orgId":{"type":"string","description":"Schedule organization id"},"credentialId":{"type":"string","description":"Scorecard id"},"isActive":{"type":"boolean","description":"Schedule is active or not"},"createdBy":{"type":"string","description":"Schedule created by"},"createdDateTime":{"format":"date-time","type":"string","description":"Schedule created date time"},"lastChangedDateTime":{"format":"date-time","type":"string","description":"Schedule last changed by"}},"required":["id","orgId","credentialId","isActive","createdBy","createdDateTime","lastChangedDateTime"]},"ScorecardDto":{"type":"object","properties":{"id":{"type":"string","description":"Scorecard id"},"orgId":{"type":"string","description":"Scorecard organization id"},"name":{"type":"string","description":"Scorecard name"},"description":{"type":"string","description":"Scorecard description"},"icon":{"type":"string","description":"Scorecard icon","enum":["activity","chart","check","crown","default","deployment","destination","development","diagram","health","piece","progress","ready","time","trend_up"]},"metrics":{"description":"Scorecard metrics","type":"array","items":{"type":"array"}},"services":{"description":"Scorecard service ids","type":"array","items":{"type":"array"}},"createdBy":{"type":"string","description":"Scorecard created by"},"lastChangedBy":{"type":"string","description":"Scorecard last changed by"},"createdAt":{"format":"date-time","type":"string","description":"Scorecard created at"},"updatedAt":{"format":"date-time","type":"string","description":"Scorecard updated at"},"notifications":{"type":"array","description":"Scorecard notifications","items":{"type":"string","enum":["DISCOVERY","DISCOVERY_ON_DEMAND","SCORECARD_AGGREGATION","SCORECARD_AGGREGATION_ON_DEMAND","SCORECARD_NOTIFICATION","SERVICE_NOTIFICATION","AUTOMAPPING_BY_TAGS","AUTOMAPPING_PERMISSIONS_BY_PATTERNS","CREDENTIALS_NOTIFICATION","SSA_TERMINATION","COSTS_RECALCULATE","CALCULATE_SERVICE_DETAILS"]}},"isEvaluating":{"type":"boolean","description":"Scorecard is evaluating"},"evaluatedAt":{"format":"date-time","type":"string","description":"Scorecard evaluated at"},"evaluateTotal":{"type":"number","description":"Scorecard evaluate total"},"evaluatePassed":{"type":"number","description":"Scorecard evaluate passed"},"evaluateFailed":{"type":"number","description":"Scorecard evaluate failed"},"evaluatePercentage":{"type":"number","description":"Scorecard evaluate percentage"},"evaluateServicesPercentage":{"type":"number","description":"Scorecard evaluate services percentage"},"autoApply":{"type":"boolean","description":"Scorecard auto apply services"},"startAt":{"format":"date-time","type":"string","nullable":true,"description":"Scorecard start at"},"dueAt":{"format":"date-time","type":"string","nullable":true,"description":"Scorecard due at"},"generalAccess":{"type":"array","items":{"type":"string","enum":["read","create","modify","delete","inherit","execute"]}},"daysLeft":{"type":"number","nullable":true,"description":"Scorecard valid days left"},"status":{"type":"string","enum":["ACTIVE","DRAFT","ARCHIVED"],"description":"Scorecard status"},"permissions":{"type":"object"}},"required":["id","orgId","name","description","icon","metrics","services","createdBy","lastChangedBy","createdAt","updatedAt","notifications","isEvaluating","evaluatedAt","evaluateTotal","evaluatePassed","evaluateFailed","evaluatePercentage","evaluateServicesPercentage","autoApply","generalAccess","status","permissions"]},"ScorecardPageDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ScorecardDto"}},"totalFound":{"type":"number","description":"Total scorecards found"},"pageNumber":{"type":"number","description":"Requested page, note that it starts with 0"},"pageSize":{"type":"number","description":"Maximum scorecards in one paginated response"}},"required":["items","totalFound","pageNumber","pageSize"]},"ScorecardMetricDto":{"type":"object","properties":{"id":{"type":"string","description":"The id of the scorecard metric."},"orgId":{"type":"string","description":"The organization id of the scorecard."},"measurementId":{"type":"string","description":"The id of the measurement."},"name":{"type":"string","description":"The name of the scorecard metric."},"description":{"type":"string","description":"The description of the scorecard metric."},"comparisonOperator":{"type":"string","description":"The comparison operator of the scorecard metric.","enum":["equal","less than","less than or equal","greater than","greater than or equal","contains text","text begins with","text ends with","text matches regexp"]},"comparisonType":{"type":"string","description":"The comparison type of the scorecard metric.","enum":["number","version","text"]},"threshold":{"type":"object","description":"The threshold of the scorecard metric."},"passOnNoData":{"type":"boolean","default":false,"description":"Whether to pass on no data or not."},"parameters":{"type":"object","description":"The parameters of the scorecard metric."},"category":{"type":"string","description":"The category of the scorecard metric.","enum":["SERVICE_METADATA","INTEGRATIONS","CODE_AND_CONFIGURATIONS"]},"icon":{"type":"string","description":"The icon of the scorecard metric.","enum":["issue-tracking","application-count","cicd-configured","code-inspection","codesmell","dependency","document-dashboard","document-link","document-text","documentation-log","documentation-runbook","environment-count","environment-resource-count","issue-tracking","jira-query-count","language","language-percentage","lifecycle","metadata-match","metadata-present","oncall","oncall-escalation","oncall-time","owner-count","repository","repository-activity","repository-approval","repository-file","resource-type","vulnerability"]},"notes":{"type":"string","description":"The notes of the scorecard metric."},"createdBy":{"type":"string","description":"The user who created the scorecard metric."},"lastChangedBy":{"type":"string","description":"The user who last changed the scorecard metric."},"createdAt":{"format":"date-time","type":"string","description":"The date when the scorecard metric was created."},"updatedAt":{"format":"date-time","type":"string","description":"The date when the scorecard metric was last updated."}},"required":["id","orgId","measurementId","name","comparisonOperator","threshold","passOnNoData","createdBy","lastChangedBy","createdAt","updatedAt"]},"ScorecardMetricPageDto":{"type":"object","properties":{"items":{"description":"List of scorecard metrics","type":"array","items":{"$ref":"#/components/schemas/ScorecardMetricDto"}},"totalFound":{"type":"number","description":"Total scorecard metrics found by this endpoint call"},"pageNumber":{"type":"number","description":"Requested page, note that it starts with 0","default":0},"pageSize":{"type":"number","description":"Maximum scorecard metrics in one paginated response","default":20,"maximum":100,"minimum":0}},"required":["items","totalFound","pageNumber","pageSize"]},"ScorecardMetricResultDto":{"type":"object","properties":{"orgId":{"type":"string","description":"The organization ID"},"metricId":{"type":"string","description":"The metric ID"},"serviceId":{"type":"string","description":"The service ID"},"scorecardId":{"type":"string","description":"The scorecard ID"},"comparisonOperator":{"type":"string","description":"The comparison operator","enum":["equal","less than","less than or equal","greater than","greater than or equal","contains text","text begins with","text ends with","text matches regexp"]},"comparisonType":{"type":"string","description":"The comparison type","enum":["number","version","text"]},"threshold":{"type":"object","description":"The threshold"},"rawResult":{"type":"object","description":"The raw result"},"pass":{"type":"boolean","description":"Is metric passed or not"},"updatedAt":{"format":"date-time","type":"string"}},"required":["orgId","metricId","serviceId","scorecardId","comparisonOperator","comparisonType","threshold","rawResult","pass","updatedAt"]},"UpdateScorecardDefinitionDto":{"type":"object","properties":{"name":{"type":"string","description":"Scorecard name"},"description":{"type":"string","description":"Scorecard description"},"icon":{"type":"string","description":"Scorecard icon","enum":["activity","chart","check","crown","default","deployment","destination","development","diagram","health","piece","progress","ready","time","trend_up"]},"metrics":{"description":"Scorecard metrics","type":"array","items":{"type":"array"}},"services":{"description":"Scorecard service ids","type":"array","items":{"type":"array"}},"lastChangedBy":{"type":"string","description":"Scorecard last changed by"},"notifications":{"type":"array","description":"Scorecard notifications","items":{"type":"string","enum":["DISCOVERY","DISCOVERY_ON_DEMAND","SCORECARD_AGGREGATION","SCORECARD_AGGREGATION_ON_DEMAND","SCORECARD_NOTIFICATION","SERVICE_NOTIFICATION","AUTOMAPPING_BY_TAGS","AUTOMAPPING_PERMISSIONS_BY_PATTERNS","CREDENTIALS_NOTIFICATION","SSA_TERMINATION","COSTS_RECALCULATE","CALCULATE_SERVICE_DETAILS"]}},"startAt":{"format":"date-time","type":"string","nullable":true,"example":"2024-03-20T00:00:00.000Z","description":"Scorecard start at"},"dueAt":{"format":"date-time","type":"string","nullable":true,"example":"2025-03-21T23:59:59.999Z","description":"Scorecard due at"},"status":{"type":"string","enum":["ACTIVE","DRAFT","ARCHIVED"],"description":"Scorecard status"}},"required":["name","icon","metrics","services","lastChangedBy","status"]},"ModuleSettingAspectDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the setting aspect"},"value":{"type":"object","description":"The value of the setting aspect"}},"required":["name","value"]},"ModuleSettingLayoutDto":{"type":"object","properties":{"x":{"type":"number","description":"The x position of the module setting layout"},"y":{"type":"number","description":"The y position of the module setting layout"},"w":{"type":"number","description":"The width of the module setting layout"},"h":{"type":"number","description":"The height of the module setting layout"},"minW":{"type":"number","description":"The minimum width of the module setting layout"},"maxW":{"type":"number","description":"The maximum width of the module setting layout"},"minH":{"type":"number","description":"The minimum height of the module setting layout"},"maxH":{"type":"number","description":"The maximum height of the module setting layout"},"static":{"type":"boolean","description":"Whether the module setting layout is static"},"isResizable":{"type":"boolean","description":"Whether the module setting layout is resizable"},"isBounded":{"type":"boolean","description":"Whether the module setting layout is bounded"}},"required":["x","y","w","h"]},"ModuleSettingStateDto":{"type":"object","properties":{"key":{"type":"string","description":"The key of the module setting state"},"value":{"type":"string","description":"The value of the module setting state"}},"required":["key","value"]},"ModuleSettingsDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the module setting"},"serviceId":{"type":"string","description":"The unique identifier of the service associated with the module setting"},"credentialId":{"type":"string","description":"The unique identifier of the credential associated with the module setting"},"providerName":{"type":"string","enum":["GitHub","GitLab","Azure DevOps","Bitbucket","CircleCI","Datadog","EmbeddedView","Jenkins","Jira","NewRelic","OpsGenie","PagerDuty","Scorecards","SonarCloud","Splunk"],"description":"The name of the provider"},"providerType":{"type":"string","enum":["REPOS","CICD","OTHER","ISSUE_TRACKING","OMS","CODE_INSPECTION"],"description":"The type of the provider"},"orgId":{"type":"string","description":"The unique identifier of the organization associated with the module setting"},"title":{"type":"string","description":"The title of the module setting"},"uiPluginName":{"type":"string","enum":["github_actions","github_activity","gitlab_pipelines","gitlab_activity","azure_devops_activity","azure_devops_pipelines","bitbucket_pipelines","bitbucket_activity","circle_ci","datadog_embedded_dashboard","datadog_embedded_graph","datadog_monitor","datadog_slo","embedded_view","jenkins","jira_activity","new_relic_chart","opsgenie_oncall","pagerduty_oncall","scorecards","sonarcloud_repo_profile","aws_security_hub","splunk_oncall"],"description":"The name of the UI plugin associated with the module setting"},"configuration":{"description":"An array of configuration aspects for the module setting","type":"array","items":{"$ref":"#/components/schemas/ModuleSettingAspectDto"}},"layout":{"description":"The layout of the module setting","allOf":[{"$ref":"#/components/schemas/ModuleSettingLayoutDto"}]},"status":{"type":"string","description":"The status of the module setting","enum":["ACTIVE","CREDENTIAL_DISABLED","CREDENTIAL_BROKEN"]},"createdBy":{"type":"string","description":"The unique identifier of the user who created the module setting"},"lastChangedBy":{"type":"string","description":"The unique identifier of the user who last changed the module setting"},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the module setting was created"},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the module setting was last changed"},"state":{"description":"An array of state information associated with the module setting","type":"array","items":{"$ref":"#/components/schemas/ModuleSettingStateDto"}}},"required":["id","serviceId","credentialId","providerName","providerType","orgId","title","uiPluginName","configuration","layout","status","createdBy","lastChangedBy","createDateTime","lastChangedDateTime","state"]},"CreateModuleSettingsDto":{"type":"object","properties":{"serviceId":{"type":"string","description":"Existing Service identifier"},"credentialId":{"type":"string","description":"Existing Credential identifier"},"providerName":{"type":"string","enum":["GitHub","GitLab","Azure DevOps","Bitbucket","CircleCI","Datadog","EmbeddedView","Jenkins","Jira","NewRelic","OpsGenie","PagerDuty","Scorecards","SonarCloud","Splunk"],"description":"Provider name"},"providerType":{"type":"string","enum":["REPOS","CICD","OTHER","ISSUE_TRACKING","OMS","CODE_INSPECTION"],"description":"Provider type"},"title":{"type":"string","description":"Module title"},"uiPluginName":{"type":"string","enum":["github_actions","github_activity","gitlab_pipelines","gitlab_activity","azure_devops_activity","azure_devops_pipelines","bitbucket_pipelines","bitbucket_activity","circle_ci","datadog_embedded_dashboard","datadog_embedded_graph","datadog_monitor","datadog_slo","embedded_view","jenkins","jira_activity","new_relic_chart","opsgenie_oncall","pagerduty_oncall","scorecards","sonarcloud_repo_profile","aws_security_hub","splunk_oncall"],"description":"Plugin name"},"configuration":{"description":"Array of configuration aspects","type":"array","items":{"$ref":"#/components/schemas/ModuleSettingAspectDto"}},"layout":{"description":"The layout of the module setting","allOf":[{"$ref":"#/components/schemas/ModuleSettingLayoutDto"}]},"state":{"description":"Array of state information","type":"array","items":{"$ref":"#/components/schemas/ModuleSettingStateDto"}},"status":{"type":"string","enum":["ACTIVE","CREDENTIAL_DISABLED","CREDENTIAL_BROKEN"],"description":"Status of the module setting"}},"required":["serviceId","providerName","providerType","configuration","status"]},"ServiceDefinition":{"type":"object","properties":{"calls":{"description":"The list of service definitions, where the key is the name of the service","type":"array","items":{"type":"string"}}},"required":["calls"]},"GetServiceDiffDto":{"type":"object","properties":{"services":{"type":"object","description":"The list of service definitions, where the key is the name of the service","additionalProperties":{"$ref":"#/components/schemas/ServiceDefinition"}},"metatagMappingName":{"type":"string","description":"The metatag that will be used to map given services to existing ones with different names"}},"required":["services","metatagMappingName"]},"Services":{"type":"object","properties":{"added":{"description":"A list of services to be added","type":"array","items":{"type":"string"}},"mappings":{"type":"object","description":"Map where the key is a service passed in the request and the value is the name of an existing service in C8","additionalProperties":{"type":"string"}}},"required":["added","mappings"]},"Dependencies":{"type":"object","properties":{"added":{"type":"object","description":"A map of dependencies to be added, where the key is a service from the request","additionalProperties":{"type":"array","items":{"type":"string"}}},"removed":{"type":"object","description":"A map of dependencies to be removed, where the key is a service from the request","additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["added","removed"]},"SyncServicesResultDto":{"type":"object","properties":{"services":{"$ref":"#/components/schemas/Services"},"dependencies":{"$ref":"#/components/schemas/Dependencies"},"errors":{"description":"A list of errors that happened during the sync","type":"array","items":{"type":"string"}}},"required":["services","dependencies"]},"ApplyServiceDiffDto":{"type":"object","properties":{"services":{"description":"The list of service definitions, where the key is the name of the service","allOf":[{"$ref":"#/components/schemas/Services"}]},"dependencies":{"description":"The list of service dependencies to be added/removed","allOf":[{"$ref":"#/components/schemas/Dependencies"}]},"metatagMappingName":{"type":"string","description":"The metatag that will be used to map given services to existing ones with different names"}},"required":["services","dependencies","metatagMappingName"]},"CreateDeploymentDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of deployment"},"description":{"type":"string","description":"The description of deployment"},"repositoryId":{"type":"string","description":"The repository id in the Configure8 application"},"environment":{"type":"string","description":"The environment of deployment"},"status":{"type":"string","enum":["PENDING","IN_PROGRESS","FAILED","SUCCESS","CANCELLED","OTHER","UNKNOWN","INACTIVE","ABANDONED","NOT_DEPLOYED","QUEUED"],"description":"The status of deployment"},"sha":{"type":"string","description":"The commit SHA hash of deployment"},"ref":{"type":"string","description":"The commit branch of deployment"},"url":{"type":"string","description":"The url on the web page with deployment details"},"startedAt":{"format":"date-time","type":"string","example":"2024-03-20T00:00:00.000Z","description":"The start date of deployment"},"version":{"type":"string","description":"The version of deployment"},"login":{"type":"string","description":"The login of deployment owner"},"ownerEmail":{"type":"string","description":"The email of deployment owner"},"finishedAt":{"format":"date-time","type":"string","example":"2024-03-20T00:00:00.000Z","description":"The finished date of deployment"}},"required":["name","repositoryId","environment","status","sha","ref","url","startedAt"]},"DeploymentDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"orgId":{"type":"string"},"description":{"type":"string","description":"Deployment entity description"},"status":{"type":"string","enum":["PENDING","IN_PROGRESS","FAILED","SUCCESS","CANCELLED","OTHER","UNKNOWN","INACTIVE","ABANDONED","NOT_DEPLOYED","QUEUED"]},"repositoryId":{"type":"string","description":"The repository id"},"environmentId":{"type":"string","description":"The environment id"},"originalEnvironment":{"type":"string","description":"The original environment name"},"sha":{"type":"string"},"ref":{"type":"string"},"url":{"type":"string","description":"The url on the web page with detail"},"version":{"type":"string"},"login":{"type":"string"},"ownerEmail":{"type":"string"},"duration":{"type":"number"},"createdBy":{"type":"string"},"lastChangedBy":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"startedAt":{"format":"date-time","type":"string"},"finishedAt":{"format":"date-time","type":"string","nullable":true}},"required":["id","name","orgId","status","repositoryId","createdBy","lastChangedBy","createdAt","startedAt"]},"UpdateDeploymentDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of deployment"},"description":{"type":"string","description":"The description of deployment"},"status":{"type":"string","enum":["PENDING","IN_PROGRESS","FAILED","SUCCESS","CANCELLED","OTHER","UNKNOWN","INACTIVE","ABANDONED","NOT_DEPLOYED","QUEUED"],"description":"The status of deployment"},"sha":{"type":"string","description":"The commit SHA hash of deployment"},"url":{"type":"string","description":"The url on the web page with deployment details"},"version":{"type":"string","description":"The version of deployment"},"login":{"type":"string","description":"The login of deployment owner"},"ownerEmail":{"type":"string","description":"The email of deployment owner"},"startedAt":{"format":"date-time","type":"string","nullable":false,"example":"2024-03-20T00:00:00.000Z","description":"The start date of deployment"},"finishedAt":{"format":"date-time","type":"string","example":"2024-03-20T00:00:00.000Z","description":"The finished date of deployment"}}},"PaginatedResponseDto":{"type":"object","properties":{"items":{"type":"array","items":{"type":"array"}},"totalFound":{"type":"number"},"pageNumber":{"type":"number"},"pageSize":{"type":"number"},"aggregation":{"type":"object"}},"required":["items","totalFound","pageNumber","pageSize"]},"CredentialDto":{"type":"object","properties":{"id":{"type":"string","description":"Credential id"},"name":{"type":"string","description":"Credential name"},"providerName":{"type":"string","description":"Credential provider name","enum":["AWS","GCP","GitHub","GitLab","Azure DevOps","AZURE","Bitbucket","CircleCI","CustomPlugin","Datadog","EmbeddedView","HttpClient","Jenkins","Jira ","NewRelic","OpsGenie","PagerDuty","Scorecards","SonarCloud","Splunk"]},"providerType":{"type":"string","description":"Credential provider type","enum":["CLOUD","REPOS","CICD","OTHER","ISSUE_TRACKING","OMS","CODE_INSPECTION"]},"orgId":{"type":"string","description":"Credential organization id"},"configuration":{"description":"Credential configuration","type":"array","items":{"type":"array"}},"status":{"type":"string","description":"Credential status","enum":["ACTIVE","DISABLED","BROKEN"]},"createdBy":{"type":"string","description":"Credential created by"},"lastChangedBy":{"type":"string","description":"Credential last changed by"},"createDateTime":{"format":"date-time","type":"string","description":"Credential created at"},"lastChangedDateTime":{"format":"date-time","type":"string","description":"Credential updated at"},"createSchedule":{"type":"boolean","description":"Credential updated at"}},"required":["id","name","providerName","providerType","orgId","configuration","status"]},"CredentialPageDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CredentialDto"}},"totalFound":{"type":"number","description":"Total credentials found"},"pageNumber":{"type":"number","description":"Requested page, note that it starts with 0"},"pageSize":{"type":"number","description":"Maximum credentials in one paginated response"}},"required":["items","totalFound","pageNumber","pageSize"]},"CredentialAspectDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the configuration"},"value":{"type":"object","description":"Value of the configuration"}},"required":["name","value"]},"CreateCredentialDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the credential"},"providerName":{"type":"string","description":"Name of the provider","enum":["AWS","GCP","GitHub","GitLab","Azure DevOps","AZURE","Bitbucket","CircleCI","CustomPlugin","Datadog","EmbeddedView","HttpClient","Jenkins","Jira ","NewRelic","OpsGenie","PagerDuty","Scorecards","SonarCloud","Splunk"]},"providerType":{"type":"string","description":"Type of the provider","enum":["CLOUD","REPOS","CICD","OTHER","ISSUE_TRACKING","OMS","CODE_INSPECTION"]},"configuration":{"description":"Configuration of the credential","type":"array","items":{"$ref":"#/components/schemas/CredentialAspectDto"}},"status":{"type":"string","description":"Status of the credential","default":true,"enum":["ACTIVE","DISABLED","BROKEN"]}},"required":["name","providerName","providerType","configuration"]},"UpdateCredentialDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the credential"},"configuration":{"description":"Configuration of the credential","type":"array","items":{"type":"string"}},"status":{"type":"string","description":"Status of the credential","enum":["ACTIVE","DISABLED","BROKEN"]}}},"UpdateScimConfigDto":{"type":"object","properties":{"status":{"type":"string","description":"Status of SCIM","example":"ACTIVE","enum":["ACTIVE","DISABLED"]}},"required":["status"]},"ScimConfigDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"orgId":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["ACTIVE","DISABLED"]},"lastChangedBy":{"type":"string","readOnly":true}},"required":["id","orgId","status","lastChangedBy"]},"SCIMUserNameDto":{"type":"object","properties":{"familyName":{"type":"string","description":"SCIM user last name"},"givenName":{"type":"string","description":"SCIM user first name"}},"required":["familyName","givenName"]},"SCIMUserEmailDto":{"type":"object","properties":{"value":{"type":"string","description":"SCIM user email value"},"type":{"type":"string","description":"SCIM user email type"},"primary":{"type":"boolean","description":"SCIM user primary email marker"}},"required":["value","type","primary"]},"SCIMUserGroupDto":{"type":"object","properties":{"value":{"type":"string","description":"SCIM user group id"},"display":{"type":"string","description":"SCIM user group name"}},"required":["value","display"]},"SCIMUserMetaDto":{"type":"object","properties":{"resourceType":{"type":"string","description":"SCIM user meta type","enum":["User","Group"]},"created":{"type":"string","description":"SCIM user created date"},"lastModified":{"type":"string","description":"SCIM user created date"},"location":{"type":"string","description":"SCIM user API url"}},"required":["resourceType"]},"SCIMUserDto":{"type":"object","properties":{"schemas":{"type":"array","description":"SCIM user create schemas","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:api:messages:2.0:ListResponse","urn:ietf:params:scim:api:messages:2.0:Error","urn:ietf:params:scim:api:messages:2.0:PatchOp","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType"]}},"externalId":{"type":"string","description":"SCIM external user id"},"userName":{"type":"string","description":"SCIM username"},"name":{"description":"SCIM user name details","allOf":[{"$ref":"#/components/schemas/SCIMUserNameDto"}]},"displayName":{"type":"string","description":"SCIM user display name"},"active":{"type":"boolean","description":"SCIM user active status"},"emails":{"description":"SCIM user emails","type":"array","items":{"$ref":"#/components/schemas/SCIMUserEmailDto"}},"groups":{"description":"SCIM user groups","type":"array","items":{"$ref":"#/components/schemas/SCIMUserGroupDto"}},"id":{"type":"string","description":"SCIM user id"},"meta":{"description":"SCIM user meta","allOf":[{"$ref":"#/components/schemas/SCIMUserMetaDto"}]}},"required":["schemas","externalId","userName","name","displayName","active","emails","groups","id","meta"]},"SCIMErrorDto":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:api:messages:2.0:ListResponse","urn:ietf:params:scim:api:messages:2.0:Error","urn:ietf:params:scim:api:messages:2.0:PatchOp","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType"]}},"detail":{"type":"string","readOnly":true},"status":{"type":"number","readOnly":true}},"required":["schemas","detail","status"]},"SCIMUserListDto":{"type":"object","properties":{"schemas":{"type":"array","description":"SCIM user create schemas","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:api:messages:2.0:ListResponse","urn:ietf:params:scim:api:messages:2.0:Error","urn:ietf:params:scim:api:messages:2.0:PatchOp","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType"]}},"totalResults":{"type":"number","description":"Total result number"},"startIndex":{"type":"number","description":"List start index"},"itemsPerPage":{"type":"number","description":"Items per page"},"Resources":{"description":"SCIM user list","allOf":[{"$ref":"#/components/schemas/SCIMUserDto"}]}},"required":["schemas","totalResults","startIndex","itemsPerPage","Resources"]},"SCIMCreateUserDto":{"type":"object","properties":{"schemas":{"type":"array","description":"SCIM user create schemas","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:api:messages:2.0:ListResponse","urn:ietf:params:scim:api:messages:2.0:Error","urn:ietf:params:scim:api:messages:2.0:PatchOp","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType"]}},"externalId":{"type":"string","description":"SCIM external user id"},"userName":{"type":"string","description":"SCIM username"},"name":{"description":"SCIM user name details","allOf":[{"$ref":"#/components/schemas/SCIMUserNameDto"}]},"displayName":{"type":"string","description":"SCIM user display name"},"active":{"type":"boolean","description":"SCIM user active status"},"emails":{"description":"SCIM user emails","type":"array","items":{"$ref":"#/components/schemas/SCIMUserEmailDto"}},"groups":{"description":"SCIM user groups","type":"array","items":{"$ref":"#/components/schemas/SCIMUserGroupDto"}}},"required":["schemas","externalId","userName","name","displayName","active","emails","groups"]},"SCIMUserPatchBodyDto":{"type":"object","properties":{"schemas":{"description":"Patch operation schemas","type":"array","items":{"type":"string"}},"Operations":{"description":"Patch operation list","type":"array","items":{"type":"string"}}},"required":["schemas","Operations"]},"SCIMGroupMemberDto":{"type":"object","properties":{"value":{"type":"string","description":"SCIM group member id"},"$ref":{"type":"string","description":"SCIM group member API URL"},"display":{"type":"string","description":"SCIM group member name"}},"required":["value","$ref","display"]},"SCIMGroupMetaDto":{"type":"object","properties":{"resourceType":{"type":"string","description":"SCIM resource type","enum":["User","Group"]},"location":{"type":"string","description":"SCIM group API URL"}},"required":["resourceType","location"]},"SCIMGroupDto":{"type":"object","properties":{"schemas":{"type":"array","description":"SCIM group create schemas","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:api:messages:2.0:ListResponse","urn:ietf:params:scim:api:messages:2.0:Error","urn:ietf:params:scim:api:messages:2.0:PatchOp","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType"]}},"displayName":{"type":"string","description":"SCIM group name"},"members":{"description":"SCIM group members","type":"array","items":{"$ref":"#/components/schemas/SCIMGroupMemberDto"}},"id":{"type":"string","description":"SCIM group id"},"meta":{"description":"SCIM group meta","allOf":[{"$ref":"#/components/schemas/SCIMGroupMetaDto"}]}},"required":["schemas","displayName","members","id","meta"]},"SCIMGroupListDto":{"type":"object","properties":{"schemas":{"type":"array","description":"SCIM group create schemas","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:api:messages:2.0:ListResponse","urn:ietf:params:scim:api:messages:2.0:Error","urn:ietf:params:scim:api:messages:2.0:PatchOp","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType"]}},"totalResults":{"type":"number","description":"Total result number"},"startIndex":{"type":"number","description":"List start index"},"itemsPerPage":{"type":"number","description":"Items per page"},"Resources":{"description":"SCIM group list","allOf":[{"$ref":"#/components/schemas/SCIMGroupDto"}]}},"required":["schemas","totalResults","startIndex","itemsPerPage","Resources"]},"SCIMGroupCreateDto":{"type":"object","properties":{"schemas":{"type":"array","description":"SCIM group create schemas","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:api:messages:2.0:ListResponse","urn:ietf:params:scim:api:messages:2.0:Error","urn:ietf:params:scim:api:messages:2.0:PatchOp","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType"]}},"displayName":{"type":"string","description":"SCIM group name"},"members":{"description":"SCIM group members","type":"array","items":{"$ref":"#/components/schemas/SCIMGroupMemberDto"}}},"required":["schemas","displayName","members"]},"SCIMGroupUpdateDto":{"type":"object","properties":{"schemas":{"type":"array","description":"SCIM group create schemas","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:api:messages:2.0:ListResponse","urn:ietf:params:scim:api:messages:2.0:Error","urn:ietf:params:scim:api:messages:2.0:PatchOp","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType"]}},"displayName":{"type":"string","description":"SCIM group name"},"members":{"description":"SCIM group members","type":"array","items":{"$ref":"#/components/schemas/SCIMGroupMemberDto"}},"id":{"type":"string","description":"SCIM group id"}},"required":["schemas","displayName","members","id"]},"SCIMGroupPatchBodyDto":{"type":"object","properties":{"schemas":{"description":"Patch operation schemas","type":"array","items":{"type":"string"}},"Operations":{"description":"Patch operation list","type":"array","items":{"type":"string"}}},"required":["schemas","Operations"]},"SCIMSchemaPatchDto":{"type":"object","properties":{"supported":{"type":"boolean","description":"Indicates whether or not the operation is required."}},"required":["supported"]},"SCIMSchemaBulk":{"type":"object","properties":{"supported":{"type":"boolean","description":"Indicates whether or not the operation is supported."},"maxOperations":{"type":"number","description":"The maximum number of operations."},"maxPayloadSize":{"type":"number","description":"The maximum payload size in bytes."}},"required":["supported","maxOperations","maxPayloadSize"]},"SCIMSchemaFilterDto":{"type":"object","properties":{"supported":{"type":"boolean","description":"Indicates whether or not the operation is supported.","default":false},"maxResults":{"type":"number","description":"The maximum number of results returned by the server. The maximum value is 100."}},"required":["supported","maxResults"]},"SCIMSchemaChangePassword":{"type":"object","properties":{"supported":{"type":"boolean","description":"Indicates whether or not the operation is supported."}},"required":["supported"]},"SCIMSchemaSortDto":{"type":"object","properties":{"supported":{"type":"boolean","description":"Indicates whether or not the operation is supported."}},"required":["supported"]},"SCIMSchemaEtagDto":{"type":"object","properties":{"supported":{"type":"boolean","description":"Indicates whether or not the operation is supported."}},"required":["supported"]},"SCIMSchemaAuthenticationSchemaDto":{"type":"object","properties":{"name":{"type":"string","description":"The common authentication schema name, e.g., HTTP Basic."},"description":{"type":"string","description":"The description of the authentication schema."},"specUri":{"type":"string","description":"The HTTP-addressable URL pointing to the authentication schema's specification."},"documentationUri":{"type":"string","description":"The HTTP-addressable URL pointing to the authentication schema's usage documentation."},"type":{"type":"string","description":"The type of authentication schema, e.g., \"oauth\", \"oauth2\", \"oauthbearertoken\", \"httpbasic\", \"httpdigest\"."}},"required":["name","description","specUri","documentationUri","type"]},"SCIMSchemaMetaDto":{"type":"object","properties":{"resourceType":{"type":"string","description":"The resource's type. This value is always \"Schema\"."},"created":{"type":"string","description":"When this schema created."},"lastModified":{"type":"string","description":"When this schema last modified."},"version":{"type":"string","description":"The schema's version. This value is REQUIRED."},"location":{"type":"string","description":"The schema's HTTP-addressable URL relative to the Base URL of the service provider, e.g., \"/Schemas/urn:ietf:params:scim:schemas:core:2.0:User\". This value is REQUIRED."}}},"ScimSchemaServiceProviderConfigDto":{"type":"object","properties":{"schemas":{"type":"array","description":"The list of supported schemas for the resource type. The value must be one of the URIs listed in the Schemas section.","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:api:messages:2.0:ListResponse","urn:ietf:params:scim:api:messages:2.0:Error","urn:ietf:params:scim:api:messages:2.0:PatchOp","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType"]}},"documentationUri":{"type":"string","description":"The resource document uri"},"patch":{"description":"The resource path","allOf":[{"$ref":"#/components/schemas/SCIMSchemaPatchDto"}]},"bulk":{"description":"The resource bulk","allOf":[{"$ref":"#/components/schemas/SCIMSchemaBulk"}]},"filter":{"description":"The resource filter","allOf":[{"$ref":"#/components/schemas/SCIMSchemaFilterDto"}]},"changePassword":{"description":"The resource change password","allOf":[{"$ref":"#/components/schemas/SCIMSchemaChangePassword"}]},"sort":{"description":"The resource sort","allOf":[{"$ref":"#/components/schemas/SCIMSchemaSortDto"}]},"etag":{"description":"The resource etag","allOf":[{"$ref":"#/components/schemas/SCIMSchemaEtagDto"}]},"authenticationSchemes":{"description":"The resource authentication schemes","type":"array","items":{"$ref":"#/components/schemas/SCIMSchemaAuthenticationSchemaDto"}},"meta":{"description":"The resource meta","allOf":[{"$ref":"#/components/schemas/SCIMSchemaMetaDto"}]}},"required":["schemas","documentationUri","patch","bulk","filter","changePassword","sort","etag","authenticationSchemes","meta"]},"ScimResourceTypeDto":{"type":"object","properties":{"schemas":{"type":"array","description":"The list of supported schemas for the resource type. The value must be one of the URIs listed in the Schemas section.","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:api:messages:2.0:ListResponse","urn:ietf:params:scim:api:messages:2.0:Error","urn:ietf:params:scim:api:messages:2.0:PatchOp","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType"]}},"id":{"type":"string","description":"The resource type's server unique id. This is a read-only value."},"name":{"type":"string","description":"The resource type name. This is a human-readable name."},"endpoint":{"type":"string","description":"The resource type's HTTP-addressable endpoint relative to the Base URL of the service provider, e.g., \"Users\"."},"description":{"type":"string","description":"The resource type's primary/base schema URI, e.g., \"urn:ietf:params:scim:schemas:core:2.0:User\"."},"schema":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:api:messages:2.0:ListResponse","urn:ietf:params:scim:api:messages:2.0:Error","urn:ietf:params:scim:api:messages:2.0:PatchOp","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType"],"description":"The resource type's primary/base schema URI, e.g., \"urn:ietf:params:scim:schemas:core:2.0:User\"."},"schemaExtensions":{"type":"array","items":{"type":"object"},"description":"The resource type's schema extensions, e.g., \"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\". This value is OPTIONAL."},"meta":{"description":"The resource type's meta information.","allOf":[{"$ref":"#/components/schemas/SCIMSchemaMetaDto"}]}},"required":["schemas","id","name","endpoint","description","schema","schemaExtensions","meta"]},"ScimSchemaUserDto":{"type":"object","properties":{"schemas":{"type":"array","description":"The list of supported schemas for the resource type. The value must be one of the URIs listed in the Schemas section.","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:api:messages:2.0:ListResponse","urn:ietf:params:scim:api:messages:2.0:Error","urn:ietf:params:scim:api:messages:2.0:PatchOp","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType"]}},"id":{"type":"string","description":"The resource type's server unique id. This is a read-only value."},"userName":{"type":"string","description":"The resource type name. This is a human-readable name."},"meta":{"description":"The resource meta","allOf":[{"$ref":"#/components/schemas/SCIMSchemaMetaDto"}]},"active":{"type":"boolean","description":"A Boolean value indicating the User's administrative status."},"displayName":{"type":"string","description":"The name of the User, suitable for display to end-users."},"emails":{"description":"Email addresses for the user. The value SHOULD be canonicalized by the service provider.","type":"array","items":{"$ref":"#/components/schemas/SCIMUserEmailDto"}},"externalId":{"type":"string","description":"The URI of the User's photo."},"groups":{"description":"A list of groups to which the user belongs, either through direct membership, through nested groups, or dynamically calculated.","type":"array","items":{"$ref":"#/components/schemas/SCIMUserGroupDto"}},"name":{"description":"The components of the user's real name.","allOf":[{"$ref":"#/components/schemas/SCIMUserNameDto"}]}},"required":["schemas","id","userName","meta","emails","externalId","groups","name"]},"SCIMSchemaMemberDto":{"type":"object","properties":{"value":{"type":"string","description":"The value of an attribute."},"$ref":{"type":"string","description":"The URI of a resource."},"display":{"type":"string","description":"The displayName of a resource."}},"required":["value","$ref","display"]},"ScimSchemaGroupDto":{"type":"object","properties":{"schemas":{"type":"array","description":"The list of supported schemas for the resource type. The value must be one of the URIs listed in the Schemas section.","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:api:messages:2.0:ListResponse","urn:ietf:params:scim:api:messages:2.0:Error","urn:ietf:params:scim:api:messages:2.0:PatchOp","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType"]}},"id":{"type":"string","description":"The resource type's server unique id. This is a read-only value."},"displayName":{"type":"string","description":"The resource type name. This is a human-readable name."},"members":{"description":"The resource type's primary/base schema URI, e.g., \"urn:ietf:params:scim:schemas:core:2.0:User\".","type":"array","items":{"$ref":"#/components/schemas/SCIMSchemaMemberDto"}},"meta":{"description":"The resource type's meta information.","allOf":[{"$ref":"#/components/schemas/SCIMSchemaMetaDto"}]}},"required":["schemas","id","displayName","members","meta"]}}},"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}