swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector User API
schemes:
- https
tags:
- name: User
paths:
  /{tenantID}/users:
    post:
      tags:
      - User
      operationId: microsoftAzureUsersCreate
      description: Create a new user.
      parameters:
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/UserCreateParameters'
        description: Parameters to create a user.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/tenantIDInPath'
      responses:
        '201':
          description: Created. Indicates success. The new user is returned in the response body.
          schema:
            $ref: '#/definitions/User'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/GraphError'
      summary: Microsoft Azure Post Tenantid Users
    get:
      tags:
      - User
      operationId: microsoftAzureUsersList
      description: Gets list of users for the current tenant.
      parameters:
      - name: $filter
        in: query
        required: false
        type: string
        description: The filter to apply to the operation.
      - name: $expand
        in: query
        required: false
        type: string
        description: The expand value for the operation result.
      - $ref: '#/parameters/top'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/tenantIDInPath'
      responses:
        '200':
          description: OK. The operation was successful.
          schema:
            $ref: '#/definitions/UserListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/GraphError'
      x-ms-pageable:
        nextLinkName: odata.nextLink
        operationName: Users_ListNext
      x-ms-odata: '#/definitions/User'
      summary: Microsoft Azure Get Tenantid Users
  /{tenantID}/users/{upnOrObjectId}:
    get:
      tags:
      - User
      operationId: microsoftAzureUsersGet
      description: Gets user information from the directory.
      parameters:
      - name: upnOrObjectId
        in: path
        required: true
        type: string
        description: The object ID or principal name of the user for which to get information.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/tenantIDInPath'
      responses:
        '200':
          description: OK. The operation was successful.
          schema:
            $ref: '#/definitions/User'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/GraphError'
      summary: Microsoft Azure Get Tenantid Users Upnorobjectid
    patch:
      tags:
      - User
      operationId: microsoftAzureUsersUpdate
      description: Updates a user.
      parameters:
      - name: upnOrObjectId
        in: path
        required: true
        type: string
        description: The object ID or principal name of the user to update.
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/UserUpdateParameters'
        description: Parameters to update an existing user.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/tenantIDInPath'
      responses:
        '204':
          description: No Content.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/GraphError'
      summary: Microsoft Azure Patch Tenantid Users Upnorobjectid
    delete:
      tags:
      - User
      operationId: microsoftAzureUsersDelete
      description: Delete a user.
      parameters:
      - name: upnOrObjectId
        in: path
        required: true
        type: string
        description: The object ID or principal name of the user to delete.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/tenantIDInPath'
      responses:
        '204':
          description: No Content
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/GraphError'
      summary: Microsoft Azure Delete Tenantid Users Upnorobjectid
  /{tenantID}/users/{objectId}/getMemberGroups:
    post:
      tags:
      - User
      operationId: microsoftAzureUsersGetmembergroups
      description: Gets a collection that contains the object IDs of the groups of which the user is a member.
      parameters:
      - name: objectId
        in: path
        required: true
        type: string
        description: The object ID of the user for which to get group membership.
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/UserGetMemberGroupsParameters'
        description: User filtering parameters.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/tenantIDInPath'
      responses:
        '200':
          description: OK. The operation was successful.
          schema:
            $ref: '#/definitions/UserGetMemberGroupsResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/GraphError'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Post Tenantid Users Objectid Getmembergroups
definitions:
  ErrorMessage:
    type: object
    properties:
      value:
        type: string
        x-ms-client-name: message
        description: Error message value.
    description: Active Directory error message.
  SignInName:
    type: object
    properties:
      type:
        type: string
        description: A string value that can be used to classify user sign-in types in your directory, such as 'emailAddress' or 'userName'.
      value:
        type: string
        description: The sign-in used by the local account. Must be unique across the company/tenant. For example, 'johnc@example.com'.
    additionalProperties:
      type: object
    description: Contains information about a sign-in name of a local account user in an Azure Active Directory B2C tenant.
  GraphError:
    type: object
    properties:
      odata.error:
        type: object
        x-ms-client-flatten: true
        $ref: '#/definitions/OdataError'
        description: A Graph API error.
    description: Active Directory error information.
  DirectoryObject:
    type: object
    discriminator: objectType
    properties:
      objectId:
        type: string
        description: The object ID.
        readOnly: true
      objectType:
        type: string
        description: The object type.
      deletionTimestamp:
        type: string
        format: date-time
        description: The time at which the directory object was deleted.
        readOnly: true
        x-nullable: true
    required:
    - objectType
    additionalProperties:
      type: object
    description: Represents an Azure Active Directory object.
  UserGetMemberGroupsParameters:
    type: object
    properties:
      securityEnabledOnly:
        type: boolean
        description: If true, only membership in security-enabled groups should be checked. Otherwise, membership in all groups should be checked.
    additionalProperties:
      type: object
    required:
    - securityEnabledOnly
    description: Request parameters for GetMemberGroups API call.
  UserBase:
    type: object
    properties:
      immutableId:
        type: string
        description: This must be specified if you are using a federated domain for the user's userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.
      usageLocation:
        type: string
        description: 'A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: "US", "JP", and "GB".'
      givenName:
        type: string
        description: The given name for the user.
      surname:
        type: string
        description: The user's surname (family name or last name).
      userType:
        type: string
        description: A string value that can be used to classify user types in your directory, such as 'Member' and 'Guest'.
        enum:
        - Member
        - Guest
        x-ms-enum:
          name: UserType
          modelAsString: true
    additionalProperties:
      type: object
  User:
    type: object
    allOf:
    - $ref: '#/definitions/DirectoryObject'
    properties:
      immutableId:
        type: string
        description: This must be specified if you are using a federated domain for the user's userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.
      usageLocation:
        type: string
        description: 'A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: "US", "JP", and "GB".'
      givenName:
        type: string
        description: The given name for the user.
      surname:
        type: string
        description: The user's surname (family name or last name).
      userType:
        type: string
        description: A string value that can be used to classify user types in your directory, such as 'Member' and 'Guest'.
        enum:
        - Member
        - Guest
        x-ms-enum:
          name: UserType
          modelAsString: true
      accountEnabled:
        type: boolean
        description: Whether the account is enabled.
      displayName:
        type: string
        description: The display name of the user.
      userPrincipalName:
        type: string
        description: The principal name of the user.
      mailNickname:
        type: string
        description: The mail alias for the user.
      mail:
        type: string
        description: The primary email address of the user.
      signInNames:
        type: array
        items:
          $ref: '#/definitions/SignInName'
        description: The sign-in names of the user.
    description: Active Directory user information.
  UserUpdateParameters:
    type: object
    allOf:
    - $ref: '#/definitions/UserBase'
    properties:
      accountEnabled:
        type: boolean
        description: Whether the account is enabled.
      displayName:
        type: string
        description: The display name of the user.
      passwordProfile:
        $ref: '#/definitions/PasswordProfile'
        description: The password profile of the user.
      userPrincipalName:
        type: string
        description: The user principal name (someuser@contoso.com). It must contain one of the verified domains for the tenant.
      mailNickname:
        type: string
        description: The mail alias for the user.
      mail:
        type: string
        description: The primary email address of the user.
    description: Request parameters for updating an existing work or school account user.
  UserGetMemberGroupsResult:
    type: object
    properties:
      value:
        type: array
        items:
          type: string
        description: A collection of group IDs of which the user is a member.
    description: Server response for GetMemberGroups API call.
  UserListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/User'
        description: the list of users.
      odata.nextLink:
        type: string
        description: The URL to get the next set of results.
    description: Server response for Get tenant users API call.
  OdataError:
    type: object
    properties:
      code:
        type: string
        description: Error code.
      message:
        type: object
        x-ms-client-flatten: true
        $ref: '#/definitions/ErrorMessage'
        description: Error Message.
    description: Active Directory OData error information.
  UserCreateParameters:
    type: object
    allOf:
    - $ref: '#/definitions/UserBase'
    properties:
      accountEnabled:
        type: boolean
        description: Whether the account is enabled.
      displayName:
        type: string
        description: The display name of the user.
      passwordProfile:
        $ref: '#/definitions/PasswordProfile'
        description: Password Profile
      userPrincipalName:
        type: string
        description: The user principal name (someuser@contoso.com). It must contain one of the verified domains for the tenant.
      mailNickname:
        type: string
        description: The mail alias for the user.
      mail:
        type: string
        description: The primary email address of the user.
    required:
    - accountEnabled
    - displayName
    - passwordProfile
    - userPrincipalName
    - mailNickname
    description: Request parameters for creating a new work or school account user.
  PasswordProfile:
    type: object
    properties:
      password:
        type: string
        description: Password
      forceChangePasswordNextLogin:
        type: boolean
        description: Whether to force a password change on next login.
    additionalProperties:
      type: object
    required:
    - password
    description: The password profile associated with a user.
parameters:
  top:
    required: false
    default: 100
    description: (Optional) Set the maximum number of results per response.
    in: query
    maximum: 999
    minimum: 1
    name: $top
    type: integer
    x-ms-parameter-location: method
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client API version.
  tenantIDInPath:
    name: tenantID
    in: path
    required: true
    type: string
    description: The tenant ID.
    x-ms-parameter-location: client
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'