swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Organization API
schemes:
- https
tags:
- name: Organization
paths:
  /providers/Microsoft.Confluent/operations:
    get:
      tags:
      - Organization
      summary: Microsoft Azure List All Operations Provided By Microsoft Confluent
      operationId: microsoftAzureOrganizationoperationsList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/OperationListResult'
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/ResourceProviderDefaultErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        OrganizationOperations_List:
          $ref: ./examples/OrganizationOperations_List.json
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/providers/Microsoft.Confluent/organizations:
    get:
      tags:
      - Organization
      summary: Microsoft Azure List All Organizations Under The Specified Subscription
      operationId: microsoftAzureOrganizationListbysubscription
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/OrganizationResourceListResult'
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/ResourceProviderDefaultErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Organization_ListBySubscription:
          $ref: ./examples/Organization_ListBySubscription.json
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations:
    get:
      tags:
      - Organization
      summary: Microsoft Azure List All Organizations Under The Specified Resource Group
      operationId: microsoftAzureOrganizationListbyresourcegroup
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/OrganizationResourceListResult'
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/ResourceProviderDefaultErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Organization_ListByResourceGroup:
          $ref: ./examples/Organization_ListByResourceGroup.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
  : get:
      tags:
      - Organization
      summary: Microsoft Azure Get The Properties Of A Specific Organization Resource
      operationId: microsoftAzureOrganizationGet
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/OrganizationResourceNameParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/OrganizationResource'
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/ResourceProviderDefaultErrorResponse'
      x-ms-examples:
        Organization_Get:
          $ref: ./examples/Organization_Get.json
      description: Needs a more full description created.
    put:
      tags:
      - Organization
      summary: Microsoft Azure Create Organization Resource
      operationId: microsoftAzureOrganizationCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/OrganizationResourceNameParameter'
      - in: body
        name: body
        description: Organization resource model
        schema:
          $ref: '#/definitions/OrganizationResource'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/OrganizationResource'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/OrganizationResource'
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/ResourceProviderDefaultErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        Organization_Create:
          $ref: ./examples/Organization_Create.json
      description: Needs a more full description created.
    patch:
      tags:
      - Organization
      summary: Microsoft Azure Update Organization Resource
      operationId: microsoftAzureOrganizationUpdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/OrganizationResourceNameParameter'
      - in: body
        name: body
        description: Updated Organization resource
        schema:
          $ref: '#/definitions/OrganizationResourceUpdate'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/OrganizationResource'
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/ResourceProviderDefaultErrorResponse'
      x-ms-examples:
        Confluent_Update:
          $ref: ./examples/Organization_Update.json
      description: Needs a more full description created.
    delete:
      tags:
      - Organization
      summary: Microsoft Azure Delete Organization Resource
      operationId: microsoftAzureOrganizationDelete
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/OrganizationResourceNameParameter'
      responses:
        '200':
          description: Success
        '202':
          description: Accepted
        '204':
          description: The specified confluent resource does not exist in the subscription.
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/ResourceProviderDefaultErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Confluent_Delete:
          $ref: ./examples/Organization_Delete.json
      description: Needs a more full description created.
definitions:
  OfferDetail:
    description: Confluent Offer detail
    type: object
    required:
    - publisherId
    - id
    - planId
    - planName
    - termUnit
    properties:
      publisherId:
        description: Publisher Id
        maxLength: 50
        type: string
      id:
        description: Offer Id
        maxLength: 50
        type: string
      planId:
        description: Offer Plan Id
        maxLength: 50
        type: string
      planName:
        description: Offer Plan Name
        maxLength: 50
        type: string
      termUnit:
        description: Offer Plan Term unit
        maxLength: 25
        type: string
      status:
        description: SaaS Offer Status
        $ref: '#/definitions/SaaSOfferStatus'
        readOnly: true
  OperationResult:
    description: An Confluent REST API operation.
    type: object
    properties:
      name:
        description: 'Operation name: {provider}/{resource}/{operation}'
        type: string
      display:
        description: The object that represents the operation.
        $ref: '#/definitions/OperationDisplay'
      isDataAction:
        description: Indicates whether the operation is a data action
        type: boolean
  OperationDisplay:
    description: The object that represents the operation.
    type: object
    properties:
      provider:
        description: 'Service provider: Microsoft.Confluent'
        type: string
      resource:
        description: Type on which the operation is performed, e.g., 'clusters'.
        type: string
      operation:
        description: Operation type, e.g., read, write, delete, etc.
        type: string
      description:
        description: Description of the operation, e.g., 'Write confluent'.
        type: string
  UserDetail:
    description: Subscriber detail
    type: object
    required:
    - emailAddress
    properties:
      firstName:
        description: First name
        maxLength: 50
        type: string
      lastName:
        description: Last name
        maxLength: 50
        type: string
      emailAddress:
        description: Email address
        pattern: ^\S+@\S+\.\S+$
        type: string
  SaaSOfferStatus:
    enum:
    - Started
    - PendingFulfillmentStart
    - InProgress
    - Subscribed
    - Suspended
    - Reinstated
    - Succeeded
    - Failed
    - Unsubscribed
    - Updating
    type: string
    description: SaaS Offer Status for confluent RP
    title: SaaSOfferStatus
    x-ms-enum:
      modelAsString: true
      name: SaaSOfferStatus
  OrganizationResource:
    description: Organization resource.
    type: object
    x-ms-azure-resource: true
    required:
    - properties
    properties:
      id:
        description: The ARM id 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
      systemData:
        description: Metadata pertaining to creation and last modification of the resource
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        readOnly: true
      properties:
        x-ms-client-flatten: true
        description: Organization resource properties
        $ref: '#/definitions/OrganizationResourceProperties'
      tags:
        type: object
        description: Organization resource tags
        additionalProperties:
          type: string
      location:
        description: Location of Organization resource
        type: string
  OrganizationResourceProperties:
    description: Organization resource property
    type: object
    required:
    - offerDetail
    - userDetail
    properties:
      createdTime:
        format: date-time
        description: The creation time of the resource.
        type: string
        readOnly: true
      provisioningState:
        description: Provision states for confluent RP
        $ref: '#/definitions/ProvisioningState'
        readOnly: true
      organizationId:
        description: Id of the Confluent organization.
        type: string
        readOnly: true
      ssoUrl:
        description: SSO url for the Confluent organization.
        type: string
        readOnly: true
      offerDetail:
        description: Confluent offer detail
        $ref: '#/definitions/OfferDetail'
      userDetail:
        description: Subscriber detail
        $ref: '#/definitions/UserDetail'
  ProvisioningState:
    enum:
    - Accepted
    - Creating
    - Updating
    - Deleting
    - Succeeded
    - Failed
    - Canceled
    - Deleted
    - NotSpecified
    type: string
    description: Provision states for confluent RP
    title: ProvisioningState
    x-ms-enum:
      name: ProvisionState
      modelAsString: true
  OperationListResult:
    description: Result of GET request to list Confluent operations.
    type: object
    properties:
      value:
        description: List of Confluent operations supported by the Microsoft.Confluent provider.
        type: array
        items:
          $ref: '#/definitions/OperationResult'
        x-ms-identifiers:
        - name
      nextLink:
        description: URL to get the next set of operation list results if there are any.
        type: string
  OrganizationResourceUpdate:
    description: Organization Resource update
    type: object
    properties:
      tags:
        description: ARM resource tags
        type: object
        additionalProperties:
          type: string
  OrganizationResourceListResult:
    description: The response of a list operation.
    type: object
    properties:
      value:
        description: Result of a list operation.
        type: array
        items:
          $ref: '#/definitions/OrganizationResource'
      nextLink:
        description: Link to the next set of results, if any.
        type: string
  ResourceProviderDefaultErrorResponse:
    type: object
    description: Default error response for resource provider
    title: ResourceProviderDefaultErrorResponse
    properties:
      error:
        description: Response body of Error
        readOnly: true
        $ref: '#/definitions/ErrorResponseBody'
  ErrorResponseBody:
    description: Response body of Error
    title: ErrorResponseBody
    type: object
    properties:
      code:
        description: Error code
        type: string
        readOnly: true
      message:
        description: Error message
        type: string
        readOnly: true
      target:
        description: Error target
        type: string
        readOnly: true
      details:
        description: Error detail
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/ErrorResponseBody'
        x-ms-identifiers:
        - message
        - target
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    description: Client Api Version.
    required: true
    type: string
    enum:
    - 2021-09-01-preview
  OrganizationResourceNameParameter:
    in: path
    name: organizationName
    description: Organization resource name
    required: true
    type: string
    x-ms-parameter-location: method
  ResourceGroupParameter:
    in: path
    name: resourceGroupName
    description: Resource group name
    required: true
    type: string
    x-ms-parameter-location: method
  SubscriptionIdParameter:
    in: path
    name: subscriptionId
    description: Microsoft Azure subscription id
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'