User

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/azure-test-labs/json-schema/azure-test-labs-user-schema.json",
  "title": "User",
  "description": "Profile of a lab user.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/azure-test-labs-users-api-openapi.yml#/components/schemas/User",
  "allOf": [
    {
      "$ref": "#/$defs/Resource"
    }
  ],
  "properties": {
    "properties": {
      "$ref": "#/$defs/UserProperties",
      "description": "The properties of the resource.",
      "x-ms-client-flatten": true
    }
  },
  "type": "object",
  "$defs": {
    "Resource": {
      "description": "An Azure resource.",
      "properties": {
        "id": {
          "description": "The identifier of the resource.",
          "readOnly": true,
          "type": "string"
        },
        "location": {
          "description": "The location of the resource.",
          "type": "string"
        },
        "name": {
          "description": "The name of the resource.",
          "readOnly": true,
          "type": "string"
        },
        "tags": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "The tags of the resource.",
          "type": "object"
        },
        "type": {
          "description": "The type of the resource.",
          "readOnly": true,
          "type": "string"
        }
      },
      "type": "object",
      "x-ms-azure-resource": true
    },
    "UserIdentity": {
      "description": "Identity attributes of a lab user.",
      "properties": {
        "appId": {
          "description": "Set to the app Id of the client JWT making the request.",
          "type": "string"
        },
        "objectId": {
          "description": "Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.",
          "type": "string"
        },
        "principalId": {
          "description": "Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.",
          "type": "string"
        },
        "principalName": {
          "description": "Set to the principal name / UPN of the client JWT making the request.",
          "type": "string"
        },
        "tenantId": {
          "description": "Set to the tenant ID of the client JWT making the request.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "UserProperties": {
      "description": "Properties of a lab user profile.",
      "properties": {
        "createdDate": {
          "description": "The creation date of the user profile.",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "identity": {
          "$ref": "#/$defs/UserIdentity",
          "description": "The identity of the user."
        },
        "provisioningState": {
          "description": "The provisioning status of the resource.",
          "readOnly": true,
          "type": "string"
        },
        "secretStore": {
          "$ref": "#/$defs/UserSecretStore",
          "description": "The secret store of the user."
        },
        "uniqueIdentifier": {
          "description": "The unique immutable identifier of a resource (Guid).",
          "readOnly": true,
          "type": "string"
        }
      },
      "type": "object"
    },
    "UserSecretStore": {
      "description": "Properties of a user's secret store.",
      "properties": {
        "keyVaultId": {
          "description": "The ID of the user's Key vault.",
          "type": "string"
        },
        "keyVaultUri": {
          "description": "The URI of the user's Key vault.",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}