swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector JoinRequest API
schemes:
- https
tags:
- name: JoinRequest
paths:
  ? /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/joinRequests
  : get:
      tags:
      - JoinRequest
      x-ms-examples:
        JoinRequestList:
          $ref: ./examples/JoinRequestList.json
      operationId: microsoftAzureJoinrequestsList
      description: get student join requests
      parameters:
      - $ref: '#/parameters/BillingAccountNameParameter'
      - $ref: '#/parameters/BillingProfileNameParameter'
      - $ref: '#/parameters/InvoiceSectionNameParameter'
      - $ref: '#/parameters/IncludeDeniedParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: invite request list.
          schema:
            $ref: '#/definitions/JoinRequestList'
        default:
          description: Describes the error if the operation is not successful.
          schema:
            $ref: '#/definitions/ErrorResponseBody'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Billing Billingaccounts Billingaccountname Billingprofiles Billingprofilename Invoicesections Invoicesectionname Providers Microsoft Education Labs Default Joinrequests
  ? /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/joinRequests/{joinRequestName}
  : get:
      tags:
      - JoinRequest
      x-ms-examples:
        JoinRequest:
          $ref: ./examples/JoinRequest.json
      operationId: microsoftAzureJoinrequestsGet
      description: get student join requests
      parameters:
      - $ref: '#/parameters/BillingAccountNameParameter'
      - $ref: '#/parameters/BillingProfileNameParameter'
      - $ref: '#/parameters/InvoiceSectionNameParameter'
      - $ref: '#/parameters/JoinRequestNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: invite request.
          schema:
            $ref: '#/definitions/JoinRequestDetails'
        default:
          description: Describes the error if the operation is not successful.
          schema:
            $ref: '#/definitions/ErrorResponseBody'
      summary: Microsoft Azure Get Providers Microsoft Billing Billingaccounts Billingaccountname Billingprofiles Billingprofilename Invoicesections Invoicesectionname Providers Microsoft Education Labs Default Joinrequests Joinrequestname
  ? /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/joinRequests/{joinRequestName}/approve
  : post:
      tags:
      - JoinRequest
      x-ms-examples:
        JoinRequestApprove:
          $ref: ./examples/JoinRequestApproveAndDeny.json
      operationId: microsoftAzureJoinrequestsApprove
      description: Approve student joining the redeemable lab
      parameters:
      - $ref: '#/parameters/BillingAccountNameParameter'
      - $ref: '#/parameters/BillingProfileNameParameter'
      - $ref: '#/parameters/InvoiceSectionNameParameter'
      - $ref: '#/parameters/JoinRequestNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Join request approved
        default:
          description: Describes the error if the operation is not successful.
          schema:
            $ref: '#/definitions/ErrorResponseBody'
      summary: Microsoft Azure Post Providers Microsoft Billing Billingaccounts Billingaccountname Billingprofiles Billingprofilename Invoicesections Invoicesectionname Providers Microsoft Education Labs Default Joinrequests Joinrequestname Approve
  ? /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/joinRequests/{joinRequestName}/deny
  : post:
      tags:
      - JoinRequest
      x-ms-examples:
        JoinRequestDeny:
          $ref: ./examples/JoinRequestApproveAndDeny.json
      operationId: microsoftAzureJoinrequestsDeny
      description: Deny student joining the redeemable lab
      parameters:
      - $ref: '#/parameters/BillingAccountNameParameter'
      - $ref: '#/parameters/BillingProfileNameParameter'
      - $ref: '#/parameters/InvoiceSectionNameParameter'
      - $ref: '#/parameters/JoinRequestNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Join request denied
        default:
          description: Describes the error if the operation is not successful.
          schema:
            $ref: '#/definitions/ErrorResponseBody'
      summary: Microsoft Azure Post Providers Microsoft Billing Billingaccounts Billingaccountname Billingprofiles Billingprofilename Invoicesections Invoicesectionname Providers Microsoft Education Labs Default Joinrequests Joinrequestname Deny
  /providers/Microsoft.Education/redeemInvitationCode:
    post:
      tags:
      - JoinRequest
      x-ms-examples:
        RedeemCode:
          $ref: ./examples/RedeemCode.json
      operationId: microsoftAzureRedeeminvitationcode
      description: Redeem invite code to join a redeemable lab
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/RedeemRequest'
        description: Request parameters to provide redeem code.
      responses:
        '200':
          description: code redeemed
        default:
          description: Describes the error if the operation is not successful.
          schema:
            $ref: '#/definitions/ErrorResponseBody'
      summary: Microsoft Azure Post Providers Microsoft Education Redeeminvitationcode
definitions:
  ErrorResponse:
    description: Describes the format of Error response.
    type: object
    properties:
      code:
        description: Error code
        type: string
      message:
        description: Error message indicating why the operation failed.
        type: string
  JoinRequestDetails:
    description: join requests.
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/Resource
    properties:
      properties:
        $ref: '#/definitions/JoinRequestProperties'
        description: join request properties.
        x-ms-client-flatten: true
  JoinRequestProperties:
    description: Join request properties.
    type: object
    properties:
      firstName:
        type: string
        description: First Name
      lastName:
        type: string
        description: Last Name
      email:
        type: string
        description: join request email
      status:
        type: string
        enum:
        - Pending
        - Denied
        x-ms-enum:
          name: Join request status
          modelAsString: true
        description: Join request status
  RedeemRequest:
    description: redeem request.
    type: object
    required:
    - redeemCode
    - firstName
    - lastName
    properties:
      redeemCode:
        type: string
        description: redeem code
      firstName:
        type: string
        description: first name of requester
      lastName:
        type: string
        description: last name of requester
  JoinRequestList:
    description: list of join requests.
    type: object
    properties:
      value:
        description: The list of requests.
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/JoinRequestDetails'
      nextLink:
        description: the link (url) to the next page of results.
        type: string
        readOnly: true
  ErrorResponseBody:
    description: Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
    type: object
    properties:
      error:
        description: The details of the error.
        $ref: '#/definitions/ErrorResponse'
parameters:
  JoinRequestNameParameter:
    name: joinRequestName
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    description: The ID that uniquely identifies a join request.
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Version of the API to be used with the client request. Current version is 2021-12-01-preview
  BillingAccountNameParameter:
    name: billingAccountName
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    description: The ID that uniquely identifies a billing account.
  BillingProfileNameParameter:
    name: billingProfileName
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    description: The ID that uniquely identifies a billing profile.
  IncludeDeniedParameter:
    name: includeDenied
    x-ms-parameter-location: method
    in: query
    type: boolean
    description: Include denied
  InvoiceSectionNameParameter:
    name: invoiceSectionName
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    description: The ID that uniquely identifies an invoice section.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'