Atlassian · Schema

RoleActor

Details about a user assigned to a project role.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
actorGroup object
actorUser object
avatarUrl string The avatar of the role actor.
displayName string The display name of the role actor. For users, depending on the user’s privacy setting, this may return an alternative value for the user's name.
id integer The ID of the role actor.
name string This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-a
type string The type of role actor.
View JSON Schema on GitHub

JSON Schema

atlassian-roleactor-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RoleActor",
  "title": "RoleActor",
  "additionalProperties": false,
  "description": "Details about a user assigned to a project role.",
  "properties": {
    "actorGroup": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectRoleGroup"
        }
      ],
      "readOnly": true
    },
    "actorUser": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectRoleUser"
        }
      ],
      "readOnly": true
    },
    "avatarUrl": {
      "description": "The avatar of the role actor.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "displayName": {
      "description": "The display name of the role actor. For users, depending on the user\u2019s privacy setting, this may return an alternative value for the user's name.",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "description": "The ID of the role actor.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "name": {
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
      "readOnly": true,
      "type": "string"
    },
    "type": {
      "description": "The type of role actor.",
      "enum": [
        "atlassian-group-role-actor",
        "atlassian-user-role-actor"
      ],
      "readOnly": true,
      "type": "string"
    }
  },
  "type": "object",
  "xml": {
    "name": "projectRoleActor"
  }
}