null\ values are used for filtering. All other parameters are ignored. The returned roles satisfy all constraints that are specified in this search criteria. By default a result containing 1000 roles is returned.
```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PagedResponseRole":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of results.","format":"int64"},"offset":{"type":"integer","description":"The offset for the results.","format":"int64"},"limit":{"type":"integer","description":"The maximum number of results to be returned.","format":"int64"},"results":{"type":"array","description":"The list of results.","items":{"$ref":"#/components/schemas/RoleImpl"}}},"description":"Response containing the paged information."},"RoleImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. To stay backwards compatible while\nstill allowing new types of resources to be introduced, a resource discriminator property (of type\nString) has been added to the subtypes of Resource where it adds value,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nA discriminator is only added on subtypes whose declared return type can represent more than one\nkind of resource; it is omitted where the return type can only ever be a single kind, as it would\nthen always hold the same value and carry no additional information. For new types of resource\nthat didn't exist before this change, the resourceType will be BaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"description":{"type":"string","description":"The description of the resource."},"global":{"type":"boolean","description":"Whether the role is global."},"disabled":{"type":"boolean","description":"Whether the role is disabled."},"permissionList":{"type":"array","description":"The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest","items":{"type":"string","description":"The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest"}},"permissions":{"type":"array","description":"The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.","deprecated":true,"items":{"type":"string","description":"The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.","deprecated":true,"enum":["EDGE","EDGE_SITE_CONNECT","EDGE_SITE_MANAGE","EDGE_SITE_ADMINISTER","EDGE_INTEGRATION_CAPABILITY_MANAGE","EDGE_VIEW_CONNECTIONS_AND_CAPABILITIES","EDGE_VIEW_LOGS","ASSET_GRID_ADMINISTRATION","ATTACHMENT_ADD","ATTACHMENT_CHANGE","ATTACHMENT_REMOVE","COMMENT_ADD","COMMENT_CHANGE","COMMENT_REMOVE","RATING_ADD","RATING_CHANGE","RATING_REMOVE","COMMUNITY_ADD","COMMUNITY_CHANGE","COMMUNITY_REMOVE","COMMUNITY_CONFIGURE_EXTERNAL_SYSTEM","COMMUNITY_RESPONSIBILITY_ADD","COMMUNITY_RESPONSIBILITY_CHANGE","COMMUNITY_RESPONSIBILITY_REMOVE","DOMAIN_ADD","DOMAIN_CHANGE","DOMAIN_REMOVE","DOMAIN_RESPONSIBILITY_ADD","DOMAIN_RESPONSIBILITY_CHANGE","DOMAIN_RESPONSIBILITY_REMOVE","WORKFLOW_MANAGE","WORKFLOW_DESIGNER_ACCESS","ASSET_ADD","ASSET_CHANGE","ASSET_REMOVE","ASSET_STATUS_CHANGE","ASSET_TYPE_CHANGE","ASSET_TAG_CHANGE","ASSET_ATTRIBUTE_ADD","ASSET_ATTRIBUTE_CHANGE","ASSET_ATTRIBUTE_REMOVE","ASSET_RESPONSIBILITY_ADD","ASSET_RESPONSIBILITY_CHANGE","ASSET_RESPONSIBILITY_REMOVE","VIEW_PERMISSIONS_CHANGE","BUSINESS_SEMANTICS_GLOSSARY","REFERENCE_DATA_MANAGER","DATA_STEWARDSHIP_MANAGER","SYSTEM_ADMINISTRATION","USER_ADMINISTRATION","WORKFLOW_ADMINISTRATION","DATA_HELPDESK","POLICY_MANAGER","DATA_DICTIONARY","CATALOG","WORKFLOW_MANAGE_ALL","WORKFLOW_MESSAGE_EVENTS_USE","VIEW_PERMISSIONS_VIEW_ALL","VIEW_MANAGE","VIEW_SHARE","VIEW_MANAGE_ALL","ADVANCED_DATA_TYPE_ADD","ADVANCED_DATA_TYPE_EDIT","ADVANCED_DATA_TYPE_REMOVE","TAGS_VIEW","TAGS_MANAGE","VALIDATION_EXECUTION","ACCESS_DATA","VIEW_SAMPLES","RELATION_TYPE_ADD","RELATION_TYPE_REMOVE","RELATION_TYPE_CHANGE","REGISTER_PROFILING_INFORMATION","REPORTING_DOWNLOAD_INSIGHTS_DATA","REPORTING_VIEW_INSIGHTS_REPORTS","INSIGHTS_VIEW","INSIGHTS_SUMMARY","TECHNICAL_LINEAGE","LOGS_VIEW","RESOURCE_MANAGE_ALL","CONFIGURATION_VIEW","CONFIGURATION_EDIT","BACKSTORE_VIEW","BACKSTORE_EDIT","ASSESSMENTS","METADATA_LAKE","PROTECT","PROTECT_EDIT","PROTECT_ADMINISTRATION","PRIVACY"]}}},"description":"Represents a role.A role is a grouping of rights and responsibilities (permissions) that is assigned to individual users or user groups.
Collibra DGC distinguishes between global roles and resource roles."}}},"paths":{"/roles":{"get":{"tags":["Roles"],"summary":"Returns roles matching the given search criteria.","description":"Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored. The returned roles satisfy all constraints that are specified in this search criteria. By default a result containing 1000 roles is returned.","operationId":"findRoles","parameters":[{"name":"offset","in":"query","description":"The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.","schema":{"type":"integer","format":"int32","default":0}},{"name":"countLimit","in":"query","description":"Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped","schema":{"type":"integer","format":"int32","default":-1}},{"name":"name","in":"query","description":"The name of the role to search for.","schema":{"type":"string"}},{"name":"nameMatchMode","in":"query","description":"The match mode used to compare name. The search is case-insensitive.","schema":{"type":"string","enum":["START","END","ANYWHERE","EXACT"],"default":"ANYWHERE"}},{"name":"description","in":"query","description":"The description of the role to search for.","schema":{"type":"string"}},{"name":"global","in":"query","description":"Whether global roles should be searched for.","deprecated":true,"schema":{"type":"boolean"}},{"name":"ownerId","in":"query","description":"The id of the owner of the roles. This can be a user or a group.","schema":{"type":"string","format":"uuid"}},{"name":"roleInheritanceMode","in":"query","description":"How to include inherited roles from groups in the search results. Allowable values are DIRECTLY, VIA_GROUPS, DIRECTLY_AND_VIA_GROUPS.","schema":{"type":"string","enum":["DIRECTLY","VIA_GROUPS","DIRECTLY_AND_VIA_GROUPS"],"default":"DIRECTLY_AND_VIA_GROUPS"}},{"name":"sortField","in":"query","description":"The sort field for the result.","schema":{"type":"string","enum":["NAME","LICENSE_TYPE"],"default":"LICENSE_TYPE"}},{"name":"sortOrder","in":"query","description":"The order of sorting.","schema":{"type":"string","enum":["ASC","DESC"],"default":"DESC"}},{"name":"includeDisabled","in":"query","description":"Whether disabled roles should be searched for.","schema":{"type":"boolean"}},{"name":"systemName","in":"query","description":"If set, search returns only resource roles having permissions belonging to a specific system. Supported values are 'knowledgegraph' and 'dataquality'. It must be used in combination with type = RESOURCE or global = false.","schema":{"type":"string"}},{"name":"type","in":"query","description":"Indicates which type of roles should be searched for. Usage is mutually exclusive with the deprecated global flag.","schema":{"type":"string","enum":["ALL","GLOBAL","RESOURCE"]}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseRole"}}}}}}}}}
```
## Adds a new role.
> Adds new role.
```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"AddRoleRequest":{"required":["name"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the new role. Should be unique within all roles
It should have a format of universally unique identifier (UUID) and should not start
with 00000000-0000-0000- which is a reserved prefix.","format":"uuid"},"name":{"maxLength":255,"minLength":1,"type":"string","description":"The name of the new role. Should be unique within all roles."},"global":{"type":"boolean","description":"Whether the role should be a global or resource role."},"description":{"type":"string","description":"The description of the role."},"permissions":{"type":"array","description":"The permissions to be granted for this role.","items":{"type":"string","description":"The permissions to be granted for this role.","enum":["EDGE","EDGE_CHART_UPLOAD","EDGE_SITE_CONNECT","EDGE_SITE_MANAGE","EDGE_SITE_ADMINISTER","EDGE_INTEGRATION_CAPABILITY_MANAGE","EDGE_VIEW_CONNECTIONS_AND_CAPABILITIES","EDGE_VIEW_LOGS","ASSET_GRID_ADMINISTRATION","ATTACHMENT_ADD","ATTACHMENT_CHANGE","ATTACHMENT_REMOVE","COMMENT_ADD","COMMENT_CHANGE","COMMENT_REMOVE","RATING_ADD","RATING_CHANGE","RATING_REMOVE","RESOURCE_EXPORT","RESOURCE_IMPORT","COMMUNITY_ADD","COMMUNITY_CHANGE","COMMUNITY_REMOVE","COMMUNITY_CONFIGURE_EXTERNAL_SYSTEM","COMMUNITY_RESPONSIBILITY_ADD","COMMUNITY_RESPONSIBILITY_CHANGE","COMMUNITY_RESPONSIBILITY_REMOVE","DOMAIN_ADD","DOMAIN_CHANGE","DOMAIN_REMOVE","DOMAIN_RESPONSIBILITY_ADD","DOMAIN_RESPONSIBILITY_CHANGE","DOMAIN_RESPONSIBILITY_REMOVE","WORKFLOW_MANAGE","WORKFLOW_DESIGNER_ACCESS","ASSET_ADD","ASSET_CHANGE","ASSET_REMOVE","ASSET_STATUS_CHANGE","ASSET_TYPE_CHANGE","ASSET_TAG_CHANGE","ASSET_ATTRIBUTE_ADD","ASSET_ATTRIBUTE_CHANGE","ASSET_ATTRIBUTE_REMOVE","ASSET_RESPONSIBILITY_ADD","ASSET_RESPONSIBILITY_CHANGE","ASSET_RESPONSIBILITY_REMOVE","ASSET_DECISION_RECORD","ASSET_PROGRESS_TRACKER_ASSESSMENT","ASSET_PROGRESS_TRACKER_SIGN_OFF","ASSET_PROGRESS_TRACKER_UPDATE_STATUS","VIEW_PERMISSIONS_CHANGE","BUSINESS_SEMANTICS_GLOSSARY","REFERENCE_DATA_MANAGER","DATA_STEWARDSHIP_MANAGER","SYSTEM_ADMINISTRATION","USER_ADMINISTRATION","WORKFLOW_ADMINISTRATION","DATA_HELPDESK","POLICY_MANAGER","DATA_DICTIONARY","CATALOG","WORKFLOW_MANAGE_ALL","WORKFLOW_MESSAGE_EVENTS_USE","VIEW_PERMISSIONS_VIEW_ALL","VIEW_MANAGE","VIEW_SHARE","VIEW_MANAGE_ALL","DATA_CLASSES_READ","DATA_CLASSES_ADD","DATA_CLASSES_EDIT","DATA_CLASSES_REMOVE","DATA_CLASSES_LIST_VALUES","ADVANCED_DATA_TYPE_ADD","ADVANCED_DATA_TYPE_EDIT","ADVANCED_DATA_TYPE_REMOVE","TAGS_VIEW","TAGS_MANAGE","VALIDATION_EXECUTION","ACCESS_DATA","VIEW_SAMPLES","RELATION_TYPE_ADD","RELATION_TYPE_REMOVE","RELATION_TYPE_CHANGE","REGISTER_PROFILING_INFORMATION","REPORTING_DOWNLOAD_INSIGHTS_DATA","REPORTING_VIEW_INSIGHTS_REPORTS","INSIGHTS_VIEW","INSIGHTS_SUMMARY","TECHNICAL_LINEAGE","LINEAGE_API_READ","LINEAGE_API_WRITE","LOGS_VIEW","RESOURCE_MANAGE_ALL","READ_ONLY_ATTRIBUTES_OVERRIDE","CONFIGURATION_VIEW","CONFIGURATION_EDIT","BACKSTORE_VIEW","BACKSTORE_EDIT","ASSESSMENTS","ASSESSMENTS_ADMINISTRATION","ASSESSMENTS_CONDUCT_ASSESSMENTS","ASSESSMENTS_MANAGE_TEMPLATES","METADATA_LAKE","PROTECT","PROTECT_EDIT","PROTECT_ADMINISTRATION","AI_GOVERNANCE","AI_GOVERNANCE_REGISTER_AI_AGENT","AI_GOVERNANCE_REGISTER_AI_MODEL","AI_GOVERNANCE_REGISTER_AI_USE_CASE","AI_GOVERNANCE_SUMMARY_DASHBOARD","AI_GOVERNANCE_DASHBOARD_ADMINISTRATION","PRIVACY","DATA_MARKETPLACE","CLASSIFY","WORKFLOW_START","WORKFLOW_PARTICIPATION","DATA_NOTEBOOK","DATA_NOTEBOOK_MANAGE_DATA_SOURCES","DATA_NOTEBOOK_MANAGE_SETTINGS","DATA_NOTEBOOK_MANAGE_ALL_NOTEBOOKS","VIEW_NOTEBOOK","GUIDED_STEWARDSHIP","DATA_MARKETPLACE_MANAGE","DATA_QUALITY_INTEGRATION","DATA_QUALITY","DATA_QUALITY_MANAGE_DATA_SOURCES","DATA_QUALITY_MANAGE_SETTINGS","DATA_QUALITY_MANAGE_TEMPLATES","DATA_QUALITY_DEPLOY_TEMPLATES","DATA_QUALITY_MANAGE_DQ_DASHBOARDS","DATA_QUALITY_CONNECTION_VIEW","DATA_QUALITY_CONNECTION_RESPONSIBILITIES_ADD","DATA_QUALITY_CONNECTION_RESPONSIBILITIES_REMOVE","DATA_QUALITY_JOB_VIEW","DATA_QUALITY_JOB_CREATE","DATA_QUALITY_JOB_DELETE","DATA_QUALITY_JOB_RUN","DATA_QUALITY_JOB_SCHEDULE","DATA_QUALITY_JOB_EDIT","DATA_QUALITY_JOB_ACCESS_LOGS","DATA_QUALITY_JOB_RESPONSIBILITIES_ADD","DATA_QUALITY_JOB_RESPONSIBILITIES_REMOVE","DATA_QUALITY_JOB_TRAIN_MONITORS","DATA_QUALITY_JOB_CREATE_MONITORS","DATA_QUALITY_JOB_EDIT_MONITORS","DATA_QUALITY_JOB_DELETE_MONITORS","DATA_QUALITY_JOB_PREVIEW_RULE_BREAK_RECORDS","AI_COPILOT","MAESTRO_STUDIO","MANAGE_ALL_AI_AGENTS","MANAGE_OWN_AI_AGENTS","PUBLISH_AI_AGENTS","DATA_CONTRACT","CONTROL_TOWER","ASSET_CONTROL_ACTIVATE_AND_RUN","UNSTRUCTURED_AI","MANAGE_UNSTRUCTURED_JOBS","MANAGE_UNSTRUCTURED_CONNECTIONS","DATA_ACCESS","DATA_ACCESS_CALL_SYNC_APIS","DATA_ACCESS_CREATE_ACCESS_CONTROLS","DATA_ACCESS_MANAGE_ALL_ACCESS","DATA_ACCESS_MANAGE_SETTINGS","DATA_ACCESS_VIEW_ALL_ACCESS_AND_USAGE","MANAGE_DATA_ACCESS","DATA_PRODUCTS","DATA_PRODUCTS_MANAGE_APPLICATION_LAYOUT"]}},"disabled":{"type":"boolean","description":"Whether the role should be disabled or not. By default, the role is enabled."}}},"RoleImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. To stay backwards compatible while\nstill allowing new types of resources to be introduced, a resource discriminator property (of type\nString) has been added to the subtypes of Resource where it adds value,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nA discriminator is only added on subtypes whose declared return type can represent more than one\nkind of resource; it is omitted where the return type can only ever be a single kind, as it would\nthen always hold the same value and carry no additional information. For new types of resource\nthat didn't exist before this change, the resourceType will be BaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"description":{"type":"string","description":"The description of the resource."},"global":{"type":"boolean","description":"Whether the role is global."},"disabled":{"type":"boolean","description":"Whether the role is disabled."},"permissionList":{"type":"array","description":"The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest","items":{"type":"string","description":"The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest"}},"permissions":{"type":"array","description":"The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.","deprecated":true,"items":{"type":"string","description":"The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.","deprecated":true,"enum":["EDGE","EDGE_SITE_CONNECT","EDGE_SITE_MANAGE","EDGE_SITE_ADMINISTER","EDGE_INTEGRATION_CAPABILITY_MANAGE","EDGE_VIEW_CONNECTIONS_AND_CAPABILITIES","EDGE_VIEW_LOGS","ASSET_GRID_ADMINISTRATION","ATTACHMENT_ADD","ATTACHMENT_CHANGE","ATTACHMENT_REMOVE","COMMENT_ADD","COMMENT_CHANGE","COMMENT_REMOVE","RATING_ADD","RATING_CHANGE","RATING_REMOVE","COMMUNITY_ADD","COMMUNITY_CHANGE","COMMUNITY_REMOVE","COMMUNITY_CONFIGURE_EXTERNAL_SYSTEM","COMMUNITY_RESPONSIBILITY_ADD","COMMUNITY_RESPONSIBILITY_CHANGE","COMMUNITY_RESPONSIBILITY_REMOVE","DOMAIN_ADD","DOMAIN_CHANGE","DOMAIN_REMOVE","DOMAIN_RESPONSIBILITY_ADD","DOMAIN_RESPONSIBILITY_CHANGE","DOMAIN_RESPONSIBILITY_REMOVE","WORKFLOW_MANAGE","WORKFLOW_DESIGNER_ACCESS","ASSET_ADD","ASSET_CHANGE","ASSET_REMOVE","ASSET_STATUS_CHANGE","ASSET_TYPE_CHANGE","ASSET_TAG_CHANGE","ASSET_ATTRIBUTE_ADD","ASSET_ATTRIBUTE_CHANGE","ASSET_ATTRIBUTE_REMOVE","ASSET_RESPONSIBILITY_ADD","ASSET_RESPONSIBILITY_CHANGE","ASSET_RESPONSIBILITY_REMOVE","VIEW_PERMISSIONS_CHANGE","BUSINESS_SEMANTICS_GLOSSARY","REFERENCE_DATA_MANAGER","DATA_STEWARDSHIP_MANAGER","SYSTEM_ADMINISTRATION","USER_ADMINISTRATION","WORKFLOW_ADMINISTRATION","DATA_HELPDESK","POLICY_MANAGER","DATA_DICTIONARY","CATALOG","WORKFLOW_MANAGE_ALL","WORKFLOW_MESSAGE_EVENTS_USE","VIEW_PERMISSIONS_VIEW_ALL","VIEW_MANAGE","VIEW_SHARE","VIEW_MANAGE_ALL","ADVANCED_DATA_TYPE_ADD","ADVANCED_DATA_TYPE_EDIT","ADVANCED_DATA_TYPE_REMOVE","TAGS_VIEW","TAGS_MANAGE","VALIDATION_EXECUTION","ACCESS_DATA","VIEW_SAMPLES","RELATION_TYPE_ADD","RELATION_TYPE_REMOVE","RELATION_TYPE_CHANGE","REGISTER_PROFILING_INFORMATION","REPORTING_DOWNLOAD_INSIGHTS_DATA","REPORTING_VIEW_INSIGHTS_REPORTS","INSIGHTS_VIEW","INSIGHTS_SUMMARY","TECHNICAL_LINEAGE","LOGS_VIEW","RESOURCE_MANAGE_ALL","CONFIGURATION_VIEW","CONFIGURATION_EDIT","BACKSTORE_VIEW","BACKSTORE_EDIT","ASSESSMENTS","METADATA_LAKE","PROTECT","PROTECT_EDIT","PROTECT_ADMINISTRATION","PRIVACY"]}}},"description":"Represents a role.
A role is a grouping of rights and responsibilities (permissions) that is assigned to individual users or user groups.
Collibra DGC distinguishes between global roles and resource roles."}}},"paths":{"/roles":{"post":{"tags":["Roles"],"summary":"Adds a new role.","description":"Adds new role.","operationId":"addRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddRoleRequest"}}}},"responses":{"201":{"description":"Role successfully added.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleImpl"}}}},"400":{"description":"A role with the given ID already exists"}}}}}} ``` ## Returns the role identified by the given id. > Returns the role identified by the given id. ```json {"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RoleImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. To stay backwards compatible while\nstill allowing new types of resources to be introduced, a resource discriminator property (of type\nString) has been added to the subtypes of Resource where it adds value,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nA discriminator is only added on subtypes whose declared return type can represent more than one\nkind of resource; it is omitted where the return type can only ever be a single kind, as it would\nthen always hold the same value and carry no additional information. For new types of resource\nthat didn't exist before this change, the resourceType will be BaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"description":{"type":"string","description":"The description of the resource."},"global":{"type":"boolean","description":"Whether the role is global."},"disabled":{"type":"boolean","description":"Whether the role is disabled."},"permissionList":{"type":"array","description":"The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest","items":{"type":"string","description":"The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest"}},"permissions":{"type":"array","description":"The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.","deprecated":true,"items":{"type":"string","description":"The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.","deprecated":true,"enum":["EDGE","EDGE_SITE_CONNECT","EDGE_SITE_MANAGE","EDGE_SITE_ADMINISTER","EDGE_INTEGRATION_CAPABILITY_MANAGE","EDGE_VIEW_CONNECTIONS_AND_CAPABILITIES","EDGE_VIEW_LOGS","ASSET_GRID_ADMINISTRATION","ATTACHMENT_ADD","ATTACHMENT_CHANGE","ATTACHMENT_REMOVE","COMMENT_ADD","COMMENT_CHANGE","COMMENT_REMOVE","RATING_ADD","RATING_CHANGE","RATING_REMOVE","COMMUNITY_ADD","COMMUNITY_CHANGE","COMMUNITY_REMOVE","COMMUNITY_CONFIGURE_EXTERNAL_SYSTEM","COMMUNITY_RESPONSIBILITY_ADD","COMMUNITY_RESPONSIBILITY_CHANGE","COMMUNITY_RESPONSIBILITY_REMOVE","DOMAIN_ADD","DOMAIN_CHANGE","DOMAIN_REMOVE","DOMAIN_RESPONSIBILITY_ADD","DOMAIN_RESPONSIBILITY_CHANGE","DOMAIN_RESPONSIBILITY_REMOVE","WORKFLOW_MANAGE","WORKFLOW_DESIGNER_ACCESS","ASSET_ADD","ASSET_CHANGE","ASSET_REMOVE","ASSET_STATUS_CHANGE","ASSET_TYPE_CHANGE","ASSET_TAG_CHANGE","ASSET_ATTRIBUTE_ADD","ASSET_ATTRIBUTE_CHANGE","ASSET_ATTRIBUTE_REMOVE","ASSET_RESPONSIBILITY_ADD","ASSET_RESPONSIBILITY_CHANGE","ASSET_RESPONSIBILITY_REMOVE","VIEW_PERMISSIONS_CHANGE","BUSINESS_SEMANTICS_GLOSSARY","REFERENCE_DATA_MANAGER","DATA_STEWARDSHIP_MANAGER","SYSTEM_ADMINISTRATION","USER_ADMINISTRATION","WORKFLOW_ADMINISTRATION","DATA_HELPDESK","POLICY_MANAGER","DATA_DICTIONARY","CATALOG","WORKFLOW_MANAGE_ALL","WORKFLOW_MESSAGE_EVENTS_USE","VIEW_PERMISSIONS_VIEW_ALL","VIEW_MANAGE","VIEW_SHARE","VIEW_MANAGE_ALL","ADVANCED_DATA_TYPE_ADD","ADVANCED_DATA_TYPE_EDIT","ADVANCED_DATA_TYPE_REMOVE","TAGS_VIEW","TAGS_MANAGE","VALIDATION_EXECUTION","ACCESS_DATA","VIEW_SAMPLES","RELATION_TYPE_ADD","RELATION_TYPE_REMOVE","RELATION_TYPE_CHANGE","REGISTER_PROFILING_INFORMATION","REPORTING_DOWNLOAD_INSIGHTS_DATA","REPORTING_VIEW_INSIGHTS_REPORTS","INSIGHTS_VIEW","INSIGHTS_SUMMARY","TECHNICAL_LINEAGE","LOGS_VIEW","RESOURCE_MANAGE_ALL","CONFIGURATION_VIEW","CONFIGURATION_EDIT","BACKSTORE_VIEW","BACKSTORE_EDIT","ASSESSMENTS","METADATA_LAKE","PROTECT","PROTECT_EDIT","PROTECT_ADMINISTRATION","PRIVACY"]}}},"description":"Represents a role.
A role is a grouping of rights and responsibilities (permissions) that is assigned to individual users or user groups.
Collibra DGC distinguishes between global roles and resource roles."}}},"paths":{"/roles/{roleId}":{"get":{"tags":["Roles"],"summary":"Returns the role identified by the given id.","description":"Returns the role identified by the given id.","operationId":"getRole","parameters":[{"name":"roleId","in":"path","description":"The unique identifier of the role.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleImpl"}}}}}}}}}
```
## Removes the role identified by the given id.
> Removes the role identified by the given id.
```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/roles/{roleId}":{"delete":{"tags":["Roles"],"summary":"Removes the role identified by the given id.","description":"Removes the role identified by the given id.","operationId":"removeRole","parameters":[{"name":"roleId","in":"path","description":"The unique identifier of the role.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}}}}
```
## Change the role with the given id.
> Changes the role with the information that is present in the request. Only properties that are specified in this request and have not \null\ values are updated. All other properties are ignored.
```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ChangeRoleRequest":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"type":"string","description":"The new name for the role. Should be unique within all roles."},"description":{"type":"string","description":"The new description for the role."},"permissions":{"type":"array","description":"The new permissions to be set. If null, no changes are made, otherwise the current permissions are
replaced with the given ones.","items":{"type":"string","description":"The new permissions to be set. If null, no changes are made, otherwise the current permissions are
replaced with the given ones.","enum":["EDGE","EDGE_CHART_UPLOAD","EDGE_SITE_CONNECT","EDGE_SITE_MANAGE","EDGE_SITE_ADMINISTER","EDGE_INTEGRATION_CAPABILITY_MANAGE","EDGE_VIEW_CONNECTIONS_AND_CAPABILITIES","EDGE_VIEW_LOGS","ASSET_GRID_ADMINISTRATION","ATTACHMENT_ADD","ATTACHMENT_CHANGE","ATTACHMENT_REMOVE","COMMENT_ADD","COMMENT_CHANGE","COMMENT_REMOVE","RATING_ADD","RATING_CHANGE","RATING_REMOVE","RESOURCE_EXPORT","RESOURCE_IMPORT","COMMUNITY_ADD","COMMUNITY_CHANGE","COMMUNITY_REMOVE","COMMUNITY_CONFIGURE_EXTERNAL_SYSTEM","COMMUNITY_RESPONSIBILITY_ADD","COMMUNITY_RESPONSIBILITY_CHANGE","COMMUNITY_RESPONSIBILITY_REMOVE","DOMAIN_ADD","DOMAIN_CHANGE","DOMAIN_REMOVE","DOMAIN_RESPONSIBILITY_ADD","DOMAIN_RESPONSIBILITY_CHANGE","DOMAIN_RESPONSIBILITY_REMOVE","WORKFLOW_MANAGE","WORKFLOW_DESIGNER_ACCESS","ASSET_ADD","ASSET_CHANGE","ASSET_REMOVE","ASSET_STATUS_CHANGE","ASSET_TYPE_CHANGE","ASSET_TAG_CHANGE","ASSET_ATTRIBUTE_ADD","ASSET_ATTRIBUTE_CHANGE","ASSET_ATTRIBUTE_REMOVE","ASSET_RESPONSIBILITY_ADD","ASSET_RESPONSIBILITY_CHANGE","ASSET_RESPONSIBILITY_REMOVE","ASSET_DECISION_RECORD","ASSET_PROGRESS_TRACKER_ASSESSMENT","ASSET_PROGRESS_TRACKER_SIGN_OFF","ASSET_PROGRESS_TRACKER_UPDATE_STATUS","VIEW_PERMISSIONS_CHANGE","BUSINESS_SEMANTICS_GLOSSARY","REFERENCE_DATA_MANAGER","DATA_STEWARDSHIP_MANAGER","SYSTEM_ADMINISTRATION","USER_ADMINISTRATION","WORKFLOW_ADMINISTRATION","DATA_HELPDESK","POLICY_MANAGER","DATA_DICTIONARY","CATALOG","WORKFLOW_MANAGE_ALL","WORKFLOW_MESSAGE_EVENTS_USE","VIEW_PERMISSIONS_VIEW_ALL","VIEW_MANAGE","VIEW_SHARE","VIEW_MANAGE_ALL","DATA_CLASSES_READ","DATA_CLASSES_ADD","DATA_CLASSES_EDIT","DATA_CLASSES_REMOVE","DATA_CLASSES_LIST_VALUES","ADVANCED_DATA_TYPE_ADD","ADVANCED_DATA_TYPE_EDIT","ADVANCED_DATA_TYPE_REMOVE","TAGS_VIEW","TAGS_MANAGE","VALIDATION_EXECUTION","ACCESS_DATA","VIEW_SAMPLES","RELATION_TYPE_ADD","RELATION_TYPE_REMOVE","RELATION_TYPE_CHANGE","REGISTER_PROFILING_INFORMATION","REPORTING_DOWNLOAD_INSIGHTS_DATA","REPORTING_VIEW_INSIGHTS_REPORTS","INSIGHTS_VIEW","INSIGHTS_SUMMARY","TECHNICAL_LINEAGE","LINEAGE_API_READ","LINEAGE_API_WRITE","LOGS_VIEW","RESOURCE_MANAGE_ALL","READ_ONLY_ATTRIBUTES_OVERRIDE","CONFIGURATION_VIEW","CONFIGURATION_EDIT","BACKSTORE_VIEW","BACKSTORE_EDIT","ASSESSMENTS","ASSESSMENTS_ADMINISTRATION","ASSESSMENTS_CONDUCT_ASSESSMENTS","ASSESSMENTS_MANAGE_TEMPLATES","METADATA_LAKE","PROTECT","PROTECT_EDIT","PROTECT_ADMINISTRATION","AI_GOVERNANCE","AI_GOVERNANCE_REGISTER_AI_AGENT","AI_GOVERNANCE_REGISTER_AI_MODEL","AI_GOVERNANCE_REGISTER_AI_USE_CASE","AI_GOVERNANCE_SUMMARY_DASHBOARD","AI_GOVERNANCE_DASHBOARD_ADMINISTRATION","PRIVACY","DATA_MARKETPLACE","CLASSIFY","WORKFLOW_START","WORKFLOW_PARTICIPATION","DATA_NOTEBOOK","DATA_NOTEBOOK_MANAGE_DATA_SOURCES","DATA_NOTEBOOK_MANAGE_SETTINGS","DATA_NOTEBOOK_MANAGE_ALL_NOTEBOOKS","VIEW_NOTEBOOK","GUIDED_STEWARDSHIP","DATA_MARKETPLACE_MANAGE","DATA_QUALITY_INTEGRATION","DATA_QUALITY","DATA_QUALITY_MANAGE_DATA_SOURCES","DATA_QUALITY_MANAGE_SETTINGS","DATA_QUALITY_MANAGE_TEMPLATES","DATA_QUALITY_DEPLOY_TEMPLATES","DATA_QUALITY_MANAGE_DQ_DASHBOARDS","DATA_QUALITY_CONNECTION_VIEW","DATA_QUALITY_CONNECTION_RESPONSIBILITIES_ADD","DATA_QUALITY_CONNECTION_RESPONSIBILITIES_REMOVE","DATA_QUALITY_JOB_VIEW","DATA_QUALITY_JOB_CREATE","DATA_QUALITY_JOB_DELETE","DATA_QUALITY_JOB_RUN","DATA_QUALITY_JOB_SCHEDULE","DATA_QUALITY_JOB_EDIT","DATA_QUALITY_JOB_ACCESS_LOGS","DATA_QUALITY_JOB_RESPONSIBILITIES_ADD","DATA_QUALITY_JOB_RESPONSIBILITIES_REMOVE","DATA_QUALITY_JOB_TRAIN_MONITORS","DATA_QUALITY_JOB_CREATE_MONITORS","DATA_QUALITY_JOB_EDIT_MONITORS","DATA_QUALITY_JOB_DELETE_MONITORS","DATA_QUALITY_JOB_PREVIEW_RULE_BREAK_RECORDS","AI_COPILOT","MAESTRO_STUDIO","MANAGE_ALL_AI_AGENTS","MANAGE_OWN_AI_AGENTS","PUBLISH_AI_AGENTS","DATA_CONTRACT","CONTROL_TOWER","ASSET_CONTROL_ACTIVATE_AND_RUN","UNSTRUCTURED_AI","MANAGE_UNSTRUCTURED_JOBS","MANAGE_UNSTRUCTURED_CONNECTIONS","DATA_ACCESS","DATA_ACCESS_CALL_SYNC_APIS","DATA_ACCESS_CREATE_ACCESS_CONTROLS","DATA_ACCESS_MANAGE_ALL_ACCESS","DATA_ACCESS_MANAGE_SETTINGS","DATA_ACCESS_VIEW_ALL_ACCESS_AND_USAGE","MANAGE_DATA_ACCESS","DATA_PRODUCTS","DATA_PRODUCTS_MANAGE_APPLICATION_LAYOUT"]}},"disabled":{"type":"boolean","description":"Whether the role should be disabled or not."}}},"RoleImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. To stay backwards compatible while\nstill allowing new types of resources to be introduced, a resource discriminator property (of type\nString) has been added to the subtypes of Resource where it adds value,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nA discriminator is only added on subtypes whose declared return type can represent more than one\nkind of resource; it is omitted where the return type can only ever be a single kind, as it would\nthen always hold the same value and carry no additional information. For new types of resource\nthat didn't exist before this change, the resourceType will be BaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"description":{"type":"string","description":"The description of the resource."},"global":{"type":"boolean","description":"Whether the role is global."},"disabled":{"type":"boolean","description":"Whether the role is disabled."},"permissionList":{"type":"array","description":"The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest","items":{"type":"string","description":"The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest"}},"permissions":{"type":"array","description":"The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.","deprecated":true,"items":{"type":"string","description":"The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.","deprecated":true,"enum":["EDGE","EDGE_SITE_CONNECT","EDGE_SITE_MANAGE","EDGE_SITE_ADMINISTER","EDGE_INTEGRATION_CAPABILITY_MANAGE","EDGE_VIEW_CONNECTIONS_AND_CAPABILITIES","EDGE_VIEW_LOGS","ASSET_GRID_ADMINISTRATION","ATTACHMENT_ADD","ATTACHMENT_CHANGE","ATTACHMENT_REMOVE","COMMENT_ADD","COMMENT_CHANGE","COMMENT_REMOVE","RATING_ADD","RATING_CHANGE","RATING_REMOVE","COMMUNITY_ADD","COMMUNITY_CHANGE","COMMUNITY_REMOVE","COMMUNITY_CONFIGURE_EXTERNAL_SYSTEM","COMMUNITY_RESPONSIBILITY_ADD","COMMUNITY_RESPONSIBILITY_CHANGE","COMMUNITY_RESPONSIBILITY_REMOVE","DOMAIN_ADD","DOMAIN_CHANGE","DOMAIN_REMOVE","DOMAIN_RESPONSIBILITY_ADD","DOMAIN_RESPONSIBILITY_CHANGE","DOMAIN_RESPONSIBILITY_REMOVE","WORKFLOW_MANAGE","WORKFLOW_DESIGNER_ACCESS","ASSET_ADD","ASSET_CHANGE","ASSET_REMOVE","ASSET_STATUS_CHANGE","ASSET_TYPE_CHANGE","ASSET_TAG_CHANGE","ASSET_ATTRIBUTE_ADD","ASSET_ATTRIBUTE_CHANGE","ASSET_ATTRIBUTE_REMOVE","ASSET_RESPONSIBILITY_ADD","ASSET_RESPONSIBILITY_CHANGE","ASSET_RESPONSIBILITY_REMOVE","VIEW_PERMISSIONS_CHANGE","BUSINESS_SEMANTICS_GLOSSARY","REFERENCE_DATA_MANAGER","DATA_STEWARDSHIP_MANAGER","SYSTEM_ADMINISTRATION","USER_ADMINISTRATION","WORKFLOW_ADMINISTRATION","DATA_HELPDESK","POLICY_MANAGER","DATA_DICTIONARY","CATALOG","WORKFLOW_MANAGE_ALL","WORKFLOW_MESSAGE_EVENTS_USE","VIEW_PERMISSIONS_VIEW_ALL","VIEW_MANAGE","VIEW_SHARE","VIEW_MANAGE_ALL","ADVANCED_DATA_TYPE_ADD","ADVANCED_DATA_TYPE_EDIT","ADVANCED_DATA_TYPE_REMOVE","TAGS_VIEW","TAGS_MANAGE","VALIDATION_EXECUTION","ACCESS_DATA","VIEW_SAMPLES","RELATION_TYPE_ADD","RELATION_TYPE_REMOVE","RELATION_TYPE_CHANGE","REGISTER_PROFILING_INFORMATION","REPORTING_DOWNLOAD_INSIGHTS_DATA","REPORTING_VIEW_INSIGHTS_REPORTS","INSIGHTS_VIEW","INSIGHTS_SUMMARY","TECHNICAL_LINEAGE","LOGS_VIEW","RESOURCE_MANAGE_ALL","CONFIGURATION_VIEW","CONFIGURATION_EDIT","BACKSTORE_VIEW","BACKSTORE_EDIT","ASSESSMENTS","METADATA_LAKE","PROTECT","PROTECT_EDIT","PROTECT_ADMINISTRATION","PRIVACY"]}}},"description":"Represents a role.
A role is a grouping of rights and responsibilities (permissions) that is assigned to individual users or user groups.
Collibra DGC distinguishes between global roles and resource roles."}}},"paths":{"/roles/{roleId}":{"patch":{"tags":["Roles"],"summary":"Change the role with the given id.","description":"Changes the role with the information that is present in the request. Only properties that are specified in this request and have not null values are updated. All other properties are ignored.","operationId":"changeRole","parameters":[{"name":"roleId","in":"path","description":"The unique identifier of the role.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeRoleRequest"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleImpl"}}}}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://developer.collibra.com/api/references/data-governance/roles.md?ask=