swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector TeamsRequestForInformation API
schemes:
- https
tags:
- name: TeamsRequestForInformation
paths:
  /teamsRequestsForInformation:
    get:
      operationId: microsoftAzureTeamsrequestsforinformationList
      tags:
      - TeamsRequestForInformation
      summary: Microsoft Azure Get List Of Requests For Information
      description: Get list of Requests for Information with details.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/Azure.Core.TopQueryParameter'
      - $ref: '#/parameters/Azure.Core.SkipQueryParameter'
      - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter'
      - $ref: '#/parameters/FilterQueryParameter'
      - $ref: '#/parameters/RecordCountQueryParameter'
      - $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PagedRequestForInformationResource'
          headers:
            x-ms-client-request-id:
              type: string
              format: uuid
              description: An opaque, globally-unique, client-generated string identifier for the request.
            x-ms-record-count:
              type: integer
              format: int32
              description: The total number of records available for this request.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Get list of Requests for Information (Consents).:
          $ref: ./examples/ListRequestsForInformation.json
      x-ms-pageable:
        nextLinkName: nextLink
  /teamsRequestsForInformation/{tenantId}:
    get:
      operationId: microsoftAzureTeamsrequestsforinformationGetrequestforinformation
      tags:
      - TeamsRequestForInformation
      summary: Microsoft Azure Get Request For Information
      description: Get details of a specific Request for Information using its ID.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: tenantId
        in: path
        description: The Teams tenant ID which generated this Request for Information.
        required: true
        type: string
        minLength: 1
        maxLength: 36
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifMatch'
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifNoneMatch'
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifUnmodifiedSince'
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifModifiedSince'
      - $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/RequestForInformationResource'
          headers:
            ETag:
              type: string
              description: The entity tag for the response.
            x-ms-client-request-id:
              type: string
              format: uuid
              description: An opaque, globally-unique, client-generated string identifier for the request.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Get an RFI by tenant ID.:
          $ref: ./examples/GetRequestForInformation.json
    patch:
      operationId: microsoftAzureTeamsrequestsforinformationCreateorupdaterequestforinformation
      tags:
      - TeamsRequestForInformation
      summary: Microsoft Azure Create Or Update Request For Information
      description: Create of update the details of a Request for Information.
      consumes:
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: tenantId
        in: path
        description: The Teams tenant ID which generated this Request for Information.
        required: true
        type: string
        minLength: 1
        maxLength: 36
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
      - $ref: '#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId'
      - $ref: '#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent'
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifMatch'
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifNoneMatch'
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifUnmodifiedSince'
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifModifiedSince'
      - $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
      - name: resource
        in: body
        description: The resource instance.
        required: true
        schema:
          $ref: '#/definitions/RequestForInformationResourceCreateOrUpdate'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/RequestForInformationResource'
          headers:
            ETag:
              type: string
              description: The entity tag for the response.
            Repeatability-Result:
              type: string
              description: Indicates whether the repeatable request was accepted or rejected.
              enum:
              - accepted
              - rejected
              x-ms-enum:
                name: RepeatabilityResult
                modelAsString: false
                values:
                - name: accepted
                  value: accepted
                  description: If the request was accepted and the server guarantees that the server state reflects a single execution of the operation.
                - name: rejected
                  value: rejected
                  description: 'If the request was rejected because the combination of Repeatability-First-Sent and Repeatability-Request-ID were invalid

                    or because the Repeatability-First-Sent value was outside the range of values held by the server.'
            x-ms-client-request-id:
              type: string
              format: uuid
              description: An opaque, globally-unique, client-generated string identifier for the request.
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          schema:
            $ref: '#/definitions/RequestForInformationResource'
          headers:
            ETag:
              type: string
              description: The entity tag for the response.
            Repeatability-Result:
              type: string
              description: Indicates whether the repeatable request was accepted or rejected.
              enum:
              - accepted
              - rejected
              x-ms-enum:
                name: RepeatabilityResult
                modelAsString: false
                values:
                - name: accepted
                  value: accepted
                  description: If the request was accepted and the server guarantees that the server state reflects a single execution of the operation.
                - name: rejected
                  value: rejected
                  description: 'If the request was rejected because the combination of Repeatability-First-Sent and Repeatability-Request-ID were invalid

                    or because the Repeatability-First-Sent value was outside the range of values held by the server.'
            x-ms-client-request-id:
              type: string
              format: uuid
              description: An opaque, globally-unique, client-generated string identifier for the request.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Create or update a Teams request for information.:
          $ref: ./examples/PatchRequestForInformationCustomerRelationship.json
definitions:
  ContactDetails:
    type: object
    description: Contact details for an individual.
    properties:
      fullName:
        type: string
        description: The full name of the contact detail.
        minLength: 1
        readOnly: true
      email:
        type: string
        description: The email of the contact detail.
        minLength: 1
        readOnly: true
      telephoneNumber:
        type: string
        description: The telephone number of the contact detail.
        readOnly: true
      companyName:
        type: string
        description: The company name of the contact detail.
        readOnly: true
      companySize:
        type: string
        description: The company size of the contact detail.
        readOnly: true
    required:
    - fullName
    - email
  Azure.Core.Foundations.Error:
    type: object
    description: The error object.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      message:
        type: string
        description: A human-readable representation of the error.
      target:
        type: string
        description: The target of the error.
      details:
        type: array
        description: An array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/Azure.Core.Foundations.Error'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: An object containing more specific information than the current object about the error.
    required:
    - code
    - message
  RequestForInformationResource:
    type: object
    description: The configuration for a telephone number provisioned in ACG.
    properties:
      serviceProvisioningStatus:
        $ref: '#/definitions/ServiceProvisioningStatus'
        description: The status of the provisioning action associated with this resource.
        readOnly: true
      serviceProvisioningErrors:
        type: array
        description: Any errors pertaining to the provisioning of this resource.
        items:
          $ref: '#/definitions/Azure.Core.Foundations.Error'
        readOnly: true
        x-ms-identifiers: []
      id:
        type: string
        description: The ID of the Request for Information.
        readOnly: true
      tenantId:
        type: string
        description: The Teams tenant ID which generated this Request for Information.
        minLength: 1
        maxLength: 36
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        readOnly: true
      accountName:
        type: string
        description: The name of the account associated with this Request for Information.
        readOnly: true
      productContext:
        type: string
        description: Will always be 'teams'.
        readOnly: true
      operatorId:
        type: string
        description: The operator ID of the operator consent.
        readOnly: true
      status:
        $ref: '#/definitions/TeamsConsentStatus'
        description: The status of the operator consent.
        readOnly: true
      consentedOn:
        type: string
        format: date-time
        description: The time (ISO8601 format) when the operator consent is created.
        readOnly: true
      lastModifiedOn:
        type: string
        format: date-time
        description: The time (ISO8601 format) when the operator consent is last modified.
        readOnly: true
      consentedCountries:
        type: array
        description: The list of consented countries.
        items:
          type: string
        readOnly: true
      contacts:
        type: array
        description: The list of tenant contacts.
        items:
          $ref: '#/definitions/ContactDetails'
        readOnly: true
        x-ms-identifiers: []
      customerRelationship:
        $ref: '#/definitions/CustomerRelationship'
        description: The customer relationship of the operator consent.
        x-ms-mutability:
        - read
        - update
        - create
    required:
    - tenantId
  RequestForInformationResourceCreateOrUpdate:
    type: object
    description: The configuration for a telephone number provisioned in ACG.
    properties:
      customerRelationship:
        $ref: '#/definitions/CustomerRelationship'
        description: The customer relationship of the operator consent.
        x-ms-mutability:
        - read
        - update
        - create
  Azure.Core.Foundations.ErrorResponse:
    type: object
    description: A response containing error details.
    properties:
      error:
        $ref: '#/definitions/Azure.Core.Foundations.Error'
        description: The error object.
    required:
    - error
  Azure.Core.Foundations.InnerError:
    type: object
    description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: Inner error.
  TeamsConsentStatus:
    type: string
    description: The possible state for an Operator Consent.
    enum:
    - active
    - suspended
    - removed
    x-ms-enum:
      name: TeamsConsentStatus
      modelAsString: true
      values:
      - name: active
        value: active
        description: The Operator Consent is active.
      - name: suspended
        value: suspended
        description: The Operator Consent is suspended.
      - name: removed
        value: removed
        description: The Operator Consent is removed.
  PagedRequestForInformationResource:
    type: object
    description: Paged collection of RequestForInformationResource items
    properties:
      value:
        type: array
        description: The RequestForInformationResource items on this page
        items:
          $ref: '#/definitions/RequestForInformationResource'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  ServiceProvisioningStatus:
    type: string
    description: The provisioning states of an object on any relevant backend service.
    enum:
    - pending
    - synced
    - failed
    x-ms-enum:
      name: ServiceProvisioningStatus
      modelAsString: true
      values:
      - name: pending
        value: pending
        description: The object is pending provisioning.
      - name: synced
        value: synced
        description: The object has been synced with the relevant backend service.
      - name: failed
        value: failed
        description: The object provisioning operation failed with the relevant backend service.
  CustomerRelationship:
    type: object
    description: Details of a customer relationship.
    properties:
      status:
        type: string
        description: The status of the customer relationship.
        x-ms-mutability:
        - read
        - update
        - create
      lastModifiedOn:
        type: string
        format: date-time
        description: The time (ISO8601 format) when the customer relationship is last modified.
        readOnly: true
      comment:
        type: string
        description: The comment of the customer relationship.
        x-ms-mutability:
        - read
        - update
        - create
parameters:
  Azure.Core.ConditionalRequestHeaders.ifNoneMatch:
    name: If-None-Match
    in: header
    description: The request should only proceed if no entity matches this string.
    required: false
    type: string
    x-ms-parameter-location: method
    x-ms-client-name: ifNoneMatch
  Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent:
    name: Repeatability-First-Sent
    in: header
    description: Specifies the date and time at which the request was first created.
    required: false
    type: string
    format: date-time
    x-ms-parameter-location: method
    x-ms-client-name: repeatabilityFirstSent
  Azure.Core.ConditionalRequestHeaders.ifUnmodifiedSince:
    name: If-Unmodified-Since
    in: header
    description: The request should only proceed if the entity was not modified after this time.
    required: false
    type: string
    format: date-time
    x-ms-parameter-location: method
    x-ms-client-name: ifUnmodifiedSince
  Azure.Core.ClientRequestIdHeader:
    name: x-ms-client-request-id
    in: header
    description: An opaque, globally-unique, client-generated string identifier for the request.
    required: false
    type: string
    format: uuid
    x-ms-parameter-location: method
    x-ms-client-name: clientRequestId
  Azure.Core.TopQueryParameter:
    name: top
    in: query
    description: The number of result items to return.
    required: false
    type: integer
    format: int32
    x-ms-parameter-location: method
  RecordCountQueryParameter:
    name: countRecords
    in: query
    description: Whether to return a count of the total number of records available for this request.
    required: false
    type: boolean
    x-ms-parameter-location: method
  Azure.Core.ConditionalRequestHeaders.ifModifiedSince:
    name: If-Modified-Since
    in: header
    description: The request should only proceed if the entity was modified after this time.
    required: false
    type: string
    format: date-time
    x-ms-parameter-location: method
    x-ms-client-name: ifModifiedSince
  Azure.Core.MaxPageSizeQueryParameter:
    name: maxpagesize
    in: query
    description: The maximum number of result items per page.
    required: false
    type: integer
    format: int32
    x-ms-parameter-location: method
  Azure.Core.ConditionalRequestHeaders.ifMatch:
    name: If-Match
    in: header
    description: The request should only proceed if an entity matches this string.
    required: false
    type: string
    x-ms-parameter-location: method
    x-ms-client-name: ifMatch
  Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId:
    name: Repeatability-Request-ID
    in: header
    description: An opaque, globally-unique, client-generated string identifier for the request.
    required: false
    type: string
    x-ms-parameter-location: method
    x-ms-client-name: repeatabilityRequestId
  Azure.Core.SkipQueryParameter:
    name: skip
    in: query
    description: The number of result items to skip.
    required: false
    type: integer
    format: int32
    default: 0
    x-ms-parameter-location: method
  FilterQueryParameter:
    name: filter
    in: query
    description: Filter the result list using the given expression
    required: false
    type: string
    x-ms-parameter-location: method
  Azure.Core.Foundations.ApiVersionParameter:
    name: api-version
    in: query
    description: The API version to use for this operation.
    required: true
    type: string
    minLength: 1
    x-ms-parameter-location: method
    x-ms-client-name: apiVersion
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'