json.schema.api.teams.createRole.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openmetadata-core Show documentation

The newest version!

{
  "$id": "https://open-metadata.org/schema/api/teams/createRole.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateRoleRequest",
  "description": "Request for creating a Role entity",
  "type": "object",
  "javaType": "org.openmetadata.catalog.api.teams.CreateRole",
  "javaInterfaces": ["org.openmetadata.core.entity.interfaces.CreateEntity"],

  "properties": {
    "name": {
      "$ref": "../../entity/teams/role.json#/definitions/roleName"
    },
    "displayName": {
      "description": "Optional name used for display purposes. Example 'Data Consumer'",
      "type": "string"
    },
    "description": {
      "description": "Optional description of the role",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "policies": {
      "description": "Policies that is attached to this role. At least one policy is required.",
      "$ref": "../../type/entityReference.json#/definitions/entityReferenceList"
    }
  },
  "required": ["name", "policies"],
  "additionalProperties": false
}