IdentityProfile

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/IdentityProfile",
  "title": "IdentityProfile",
  "type": "object",
  "description": "An identity profile defines the mapping between source account attributes and identity attributes and configures lifecycle states for identities.",
  "required": [
    "name",
    "authoritativeSource"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The identity profile ID.",
      "readOnly": true,
      "examples": [
        "2b838de9-db9b-abcf-e646-d4f274ad4238"
      ]
    },
    "name": {
      "type": "string",
      "description": "The identity profile name.",
      "examples": [
        "HR Employees"
      ]
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "The identity profile description.",
      "examples": [
        "My custom flat file profile"
      ]
    },
    "owner": {
      "$ref": "#/components/schemas/OwnerReference"
    },
    "priority": {
      "type": "integer",
      "format": "int64",
      "description": "The identity profile priority.",
      "examples": [
        10
      ]
    },
    "authoritativeSource": {
      "$ref": "#/components/schemas/SourceReference"
    },
    "identityRefreshRequired": {
      "type": "boolean",
      "default": false,
      "description": "Set to true if an identity refresh is necessary, typically when a change has been made on the source.",
      "examples": [
        true
      ]
    },
    "identityCount": {
      "type": "integer",
      "format": "int32",
      "description": "Number of identities belonging to the identity profile.",
      "readOnly": true,
      "examples": [
        8
      ]
    },
    "hasTimeBasedAttr": {
      "type": "boolean",
      "default": false,
      "description": "Indicates the value of the requiresPeriodicRefresh attribute for the identity profile.",
      "examples": [
        true
      ]
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time the profile was created.",
      "readOnly": true,
      "examples": [
        "2023-01-03T21:16:22.432Z"
      ]
    },
    "modified": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time the profile was last modified.",
      "readOnly": true,
      "examples": [
        "2023-01-05T18:40:35.772Z"
      ]
    }
  }
}