Microsoft Azure Users API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Users API
schemes:
- https
tags:
- name: Users
paths:
  /users:
    get:
      operationId: microsoftAzureUsersList
      summary: Microsoft Azure Get The List Of Users In An Application
      x-ms-examples:
        List users:
          $ref: ./examples/users_list.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/MaxPageSize'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/UserCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - Users
  /users/{userId}:
    get:
      operationId: microsoftAzureUsersGet
      summary: Microsoft Azure Get A User By Id
      x-ms-examples:
        Get a user by ID:
          $ref: ./examples/users_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/UserId'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/User'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - Users
    put:
      operationId: microsoftAzureUsersCreate
      summary: Microsoft Azure Create A User In The Application
      x-ms-examples:
        Add or update a service principal user:
          $ref: ./examples/users_set_serviceprincipal.json
        Add or update an email user:
          $ref: ./examples/users_set.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/UserId'
      - in: body
        name: body
        description: User body.
        schema:
          $ref: '#/definitions/User'
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/User'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - Users
    patch:
      operationId: microsoftAzureUsersUpdate
      summary: Microsoft Azure Update A User In The Application Via Patch
      x-ms-examples:
        Update a service principal user:
          $ref: ./examples/users_set_serviceprincipal.json
        Update an email user:
          $ref: ./examples/users_set.json
      consumes:
      - application/json
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/UserId'
      - in: body
        name: body
        description: User patch body.
        schema:
          type: object
        required: true
      - $ref: '#/parameters/IfMatch'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/User'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - Users
    delete:
      operationId: microsoftAzureUsersRemove
      summary: Microsoft Azure Delete A User
      x-ms-examples:
        Delete a user:
          $ref: ./examples/users_delete.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/UserId'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - Users
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users
  : get:
      tags:
      - Users
      description: Gets all the users registered on a Data Box Edge/Data Box Gateway device.
      operationId: microsoftAzureUsersListbydataboxedgedevice
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - name: $filter
        in: query
        description: Specify $filter='Type eq <type>' to filter on user type property
        required: false
        type: string
      responses:
        '200':
          description: The collection of all users on the device.
          schema:
            $ref: '#/definitions/UserList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        UserGetAllInDevice:
          $ref: ./examples/UserGetAllInDevice.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Users
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}
  : get:
      tags:
      - Users
      description: Gets the properties of the specified user.
      operationId: microsoftAzureUsersGet
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: name
        in: path
        description: The user name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The user details.
          schema:
            $ref: '#/definitions/User_2'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        UserGet:
          $ref: ./examples/UserGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Users Name
    put:
      tags:
      - Users
      description: Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
      operationId: microsoftAzureUsersCreateorupdate
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: name
        in: path
        description: The user name.
        required: true
        type: string
      - name: user
        in: body
        description: The user details.
        required: true
        schema:
          $ref: '#/definitions/User_2'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the user.
          schema:
            $ref: '#/definitions/User_2'
        '202':
          description: Accepted the request to create or update the user.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        UserPut:
          $ref: ./examples/UserPut.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Users Name
    delete:
      tags:
      - Users
      description: Deletes the user on a databox edge/gateway device.
      operationId: microsoftAzureUsersDelete
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: name
        in: path
        description: The user name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully deleted the user.
        '202':
          description: Accepted the request to delete the user.
        '204':
          description: The user is already deleted.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        UserDelete:
          $ref: ./examples/UserDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Users Name
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users:
    get:
      tags:
      - Users
      description: List user profiles in a given lab.
      operationId: microsoftAzureUsersList
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: $expand
        in: query
        description: 'Specify the $expand query. Example: ''properties($select=identity)'''
        type: string
      - name: $filter
        in: query
        description: 'The filter to apply to the operation. Example: ''$filter=contains(name,''myName'')'
        type: string
      - name: $top
        in: query
        description: 'The maximum number of resources to return from the operation. Example: ''$top=10'''
        type: integer
        format: int32
      - name: $orderby
        in: query
        description: 'The ordering expression for the results, using OData notation. Example: ''$orderby=name desc'''
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/UserList_2'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError_2'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: '#/definitions/User'
      x-ms-examples:
        Users_List:
          $ref: ./examples/Users_List.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Users
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}
  : get:
      tags:
      - Users
      description: Get user profile.
      operationId: microsoftAzureUsersGet
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: name
        in: path
        description: The name of the user profile.
        required: true
        type: string
      - name: $expand
        in: query
        description: 'Specify the $expand query. Example: ''properties($select=identity)'''
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/User_3'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError_2'
      x-ms-examples:
        Users_Get:
          $ref: ./examples/Users_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Users Name
    put:
      tags:
      - Users
      description: Create or replace an existing user profile. This operation can take a while to complete.
      operationId: microsoftAzureUsersCreateorupdate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: name
        in: path
        description: The name of the user profile.
        required: true
        type: string
      - name: user
        in: body
        description: Profile of a lab user.
        required: true
        schema:
          $ref: '#/definitions/User_3'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/User_3'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/User_3'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError_2'
      x-ms-examples:
        Users_CreateOrUpdate:
          $ref: ./examples/Users_CreateOrUpdate.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Users Name
    delete:
      tags:
      - Users
      description: Delete user profile. This operation can take a while to complete.
      operationId: microsoftAzureUsersDelete
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: name
        in: path
        description: The name of the user profile.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        '204':
          description: No Content
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError_2'
      x-ms-examples:
        Users_Delete:
          $ref: ./examples/Users_Delete.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Users Name
    patch:
      tags:
      - Users
      description: Allows modifying tags of user profiles. All other properties will be ignored.
      operationId: microsoftAzureUsersUpdate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: name
        in: path
        description: The name of the user profile.
        required: true
        type: string
      - name: user
        in: body
        description: Profile of a lab user.
        required: true
        schema:
          $ref: '#/definitions/UserFragment'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/User_3'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError_2'
      x-ms-examples:
        Users_Update:
          $ref: ./examples/Users_Update.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Users Name
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users
  : get:
      tags:
      - Users
      description: List users in a given lab.
      operationId: microsoftAzureUsersList
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labAccountName
        in: path
        description: The name of the lab Account.
        required: true
        type: string
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: $expand
        in: query
        description: 'Specify the $expand query. Example: ''properties($select=email)'''
        required: false
        type: string
      - name: $filter
        in: query
        description: The filter to apply to the operation.
        required: false
        type: string
      - name: $top
        in: query
        description: The maximum number of resources to return from the operation.
        required: false
        type: integer
        format: int32
      - name: $orderby
        in: query
        description: The ordering expression for the results, using OData notation.
        required: false
        type: string
      - $ref: '#/parameters/api-version_2'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ResponseWithContinuation[User]'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError_3'
      security:
      - azure_auth:
        - user_impersonation
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: '#/definitions/User'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Users
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users/{userName}
  : get:
      tags:
      - Users
      description: Get user
      operationId: microsoftAzureUsersGet
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labAccountName
        in: path
        description: The name of the lab Account.
        required: true
        type: string
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: userName
        in: path
        description: The name of the user.
        required: true
        type: string
      - name: $expand
        in: query
        description: 'Specify the $expand query. Example: ''properties($select=email)'''
        required: false
        type: string
      - $ref: '#/parameters/api-version_2'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/User_4'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError_3'
      security:
      - azure_auth:
        - user_impersonation
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Users Username
    put:
      tags:
      - Users
      description: Create or replace an existing User.
      operationId: microsoftAzureUsersCreateorupdate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labAccountName
        in: path
        description: The name of the lab Account.
        required: true
        type: string
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: userName
        in: path
        description: The name of the user.
        required: true
        type: string
      - name: user
        in: body
        description: The User registered to a lab
        required: true
        schema:
          $ref: '#/definitions/User_4'
      - $ref: '#/parameters/api-version_2'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/User_4'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/User_4'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError_3'
      security:
      - azure_auth:
        - user_impersonation
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Users Username
    delete:
      tags:
      - Users
      description: Delete user. This operation can take a while to complete
      operationId: microsoftAzureUsersDelete
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labAccountName
        in: path
        description: The name of the lab Account.
        required: true
        type: string
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: userName
        in: path
        description: The name of the user.
        required: true
        type: string
      - $ref: '#/parameters/api-version_2'
      responses:
        '202':
          description: Accepted
        '204':
          description: No Content
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError_3'
      security:
      - azure_auth:
        - user_impersonation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Users Username
    patch:
      tags:
      - Users
      description: Modify properties of users.
      operationId: microsoftAzureUsersUpdate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labAccountName
        in: path
        description: The name of the lab Account.
        required: true
        type: string
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: userName
        in: path
        description: The name of the user.
        required: true
        type: string
      - name: user
        in: body
        description: The User registered to a lab
        required: true
        schema:
          $ref: '#/definitions/UserFragment_2'
      - $ref: '#/parameters/api-version_2'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/User_4'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError_3'
      security:
      - azure_auth:
        - user_impersonation
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Users Username
definitions:
  UserIdentity:
    description: Identity attributes of a lab user.
    type: object
    properties:
      principalName:
        description: Set to the principal name / UPN of the client JWT making the request.
        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
      tenantId:
        description: Set to the tenant 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
      appId:
        description: Set to the app Id of the client JWT making the request.
        type: string
  LatestOperationResult:
    description: Details of the status of an operation.
    type: object
    properties:
      status:
        description: The current status of the operation.
        type: string
        readOnly: true
      errorCode:
        description: Error code on failure.
        type: string
        readOnly: true
      errorMessage:
        description: The error message.
        type: string
        readOnly: true
      requestUri:
        description: Request URI of the operation.
        type: string
        readOnly: true
      httpMethod:
        description: The HttpMethod - PUT/POST/DELETE for the operation.
        type: string
        readOnly: true
      operationUrl:
        description: The URL to use to check long-running operation status
        type: string
        readOnly: true
  ErrorDetails:
    description: The detail information of the error.
    type: object
    properties:
      code:
        type: string
        description: Error code.
      message:
        type: string
        description: Error message details.
      requestId:
        type: string
        description: Correlation Id for current request.
      time:
        type: string
        format: date-time-rfc1123
        description: The time that error request failed.
    required:
    - code
    - message
  UpdateResource:
    description: Represents an update resource
    type: object
    properties:
      tags:
        description: The tags of the resource.
        type: object
        additionalProperties:
          type: string
  CloudErrorBody:
    description: An error response from the service.
    type: object
    properties:
      code:
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
        type: string
      message:
        description: A message describing the error, intended to be suitable for display in a user interface.
        type: string
      details:
        description: A list of additional details about the error.
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
        x-ms-identifiers: []
    x-ms-external: true
  User_4:
    description: The User registered to a lab
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/UserProperties_3'
        description: These are the properties for the user registered under a lab.
        x-ms-client-flatten: true
  UserProperties:
    description: The user properties.
    required:
    - userType
    type: object
    properties:
      encryptedPassword:
        $ref: '#/definitions/AsymmetricEncryptedSecret'
        description: The password details.
      shareAccessRights:
        description: List of shares that the user has rights on. This field should not be specified during user creation.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/ShareAccessRight'
        x-ms-identifiers:
        - shareId
        readOnly: true
      userType:
        description: Type of the user.
        enum:
        - Share
        - LocalManagement
        - ARM
        type: string
        x-ms-enum:
          name: UserType
          modelAsString: true
  UserCollection:
    description: The paged results of users.
    type: object
    properties:
      value:
        description: The collection of users.
        type: array
        items:
          $ref: '#/definitions/User'
      nextLink:
        description: URL to get the next page of users.
        type: string
    required:
    - value
  RoleAssignment:
    description: The role assignment definition.
    type: object
    properties:
      role:
        description: ID of the role for this role assignment.
        type: string
      organization:
        description: ID of the organization for this role assignment.
        type: string
    required:
    - role
  Resource:
    description: An Azure resource.
    type: object
    properties:
      id:
        description: The identifier of the resource.
        type: string
        readOnly: true
      name:
        description: The name of the resource.
        type: string
        readOnly: true
      type:
        description: The type of the resource.
        type: string
        readOnly: true
      location:
        description: The location of the resource.
        type: string
      tags:
        description: The tags of the resource.
        type: object
        additionalProperties:
          type: string
    x-ms-azure-resource: true
  User_2:
    description: Represents a user who has access to one or more shares on the Data Box Edge/Gateway device.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/ARMBaseModel'
    properties:
      properties:
        $ref: '#/definitions/UserProperties'
        description: The storage account credential properties.
        x-ms-client-flatten: true
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Metadata pertaining to creation and last modification of User
        readOnly: true
  UserFragment:
    description: Profile of a lab user.
    type: object
    allOf:
    - $ref: '#/definitions/UpdateResource'
    properties: {}
  UserList_2:
    description: The response of a list operation.
    type: object
    properties:
      value:
        description: Results of the list operation.
        type: array
        items:
          $ref: '#/definitions/User_3'
      nextLink:
        description: Link for next set of results.
        type: string
  UserProperties_3:
    description: Lab User properties
    type: object
    properties:
      email:
        description: The user email address, as it was specified during registration.
        type: string
        readOnly: true
      familyName:
        description: The user family name, as it was specified during registration.
        type: string
        readOnly: true
      givenName:
        description: The user given name, as it was specified during registration.
        type: string
        readOnly: true
      tenantId:
        description: The user tenant ID, as it was specified during registration.
        type: string
        readOnly: true
      totalUsage:
        format: duration
        description: How long the user has used his VMs in this lab
        type: string
        readOnly: true
      provisioningState:
        description: The provisioning status of the resource.
        type: string
      uniqueIdentifier:
        description: The unique immutable identifier of a resource (Guid).
        type: string
      latestOperationResult:
        $ref: '#/definitions/LatestOperationResult'
        description: 'The details of the latest operation. ex: status, error'
        readOnly: true
  ARMBaseModel:
    description: Represents the base class for all object models.
    type: object
    properties:
      id:
        description: The path ID that uniquely identifies the object.
        type: string
        readOnly: true
      name:
        description: The object name.
        type: string
        readOnly: true
      type:
        description: The hierarchical type of the object.
        type: string
        readOnly: true
    x-ms-azure-resource: true
  User:
    description: The user definition.
    allOf:
    - $ref: '#/d

# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-users-api-openapi.yml