swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector RoleAssignments API
schemes:
- https
tags:
- name: RoleAssignments
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/roleAssignments
  : get:
      tags:
      - RoleAssignments
      operationId: microsoftAzureRoleassignmentsListbyhub
      x-ms-examples:
        RoleAssignments_ListByHub:
          $ref: ./examples/RoleAssignmentsListByHub.json
      description: Gets all the role assignments for the specified hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: hubName
        in: path
        required: true
        type: string
        description: The name of the hub.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. Successfully get all the role assignment in the hub.
          schema:
            $ref: '#/definitions/RoleAssignmentListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Roleassignments
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/roleAssignments/{assignmentName}
  : put:
      tags:
      - RoleAssignments
      operationId: microsoftAzureRoleassignmentsCreateorupdate
      x-ms-examples:
        RoleAssignments_CreateOrUpdate:
          $ref: ./examples/RoleAssignmentsCreateOrUpdate.json
      description: Creates or updates a role assignment in the hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: hubName
        in: path
        required: true
        type: string
        description: The name of the hub.
      - name: assignmentName
        in: path
        required: true
        type: string
        description: The assignment name
        pattern: ^[a-zA-Z][a-zA-Z0-9_]+$
        minLength: 1
        maxLength: 128
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/RoleAssignmentResourceFormat'
        description: Parameters supplied to the CreateOrUpdate RoleAssignment operation.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. Successfully created the role assignment.
          schema:
            $ref: '#/definitions/RoleAssignmentResourceFormat'
        '202':
          description: Accepted. The create role assignment operation is accepted.
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Roleassignments Assignmentname
    get:
      tags:
      - RoleAssignments
      operationId: microsoftAzureRoleassignmentsGet
      x-ms-examples:
        RoleAssignments_Get:
          $ref: ./examples/RoleAssignmentsGet.json
      description: Gets the role assignment in the hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: hubName
        in: path
        required: true
        type: string
        description: The name of the hub.
      - name: assignmentName
        in: path
        required: true
        type: string
        description: The name of the role assignment.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. Successfully get the role assignment.
          schema:
            $ref: '#/definitions/RoleAssignmentResourceFormat'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Roleassignments Assignmentname
    delete:
      tags:
      - RoleAssignments
      operationId: microsoftAzureRoleassignmentsDelete
      x-ms-examples:
        RoleAssignments_Delete:
          $ref: ./examples/RoleAssignmentsDelete.json
      description: Deletes the role assignment in the hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: hubName
        in: path
        required: true
        type: string
        description: The name of the hub.
      - name: assignmentName
        in: path
        required: true
        type: string
        description: The name of the role assignment.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. The role assignment is deleted.
        '202':
          description: Accepted. The delete operation is accepted.
        '204':
          description: NoContent. Successfully requested delete operation, but the response is intentionally empty.
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Roleassignments Assignmentname
definitions:
  RoleAssignment:
    description: The Role Assignment definition.
    required:
    - role
    - principals
    properties:
      tenantId:
        type: string
        readOnly: true
        description: The hub name.
      assignmentName:
        type: string
        readOnly: true
        description: The name of the metadata object.
      displayName:
        type: object
        additionalProperties:
          type: string
        description: Localized display names for the metadata.
      description:
        type: object
        additionalProperties:
          type: string
        description: Localized description for the metadata.
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        readOnly: true
        description: Provisioning state.
      role:
        type: string
        enum:
        - Admin
        - Reader
        - ManageAdmin
        - ManageReader
        - DataAdmin
        - DataReader
        x-ms-enum:
          name: RoleTypes
          modelAsString: false
        description: Type of roles.
      principals:
        type: array
        items:
          $ref: '#/definitions/AssignmentPrincipal'
        description: The principals being assigned to.
      profiles:
        $ref: '#/definitions/ResourceSetDescription'
        description: Profiles set for the assignment.
      interactions:
        $ref: '#/definitions/ResourceSetDescription'
        description: Interactions set for the assignment.
      links:
        $ref: '#/definitions/ResourceSetDescription'
        description: Links set for the assignment.
      kpis:
        $ref: '#/definitions/ResourceSetDescription'
        description: Kpis set for the assignment.
      sasPolicies:
        $ref: '#/definitions/ResourceSetDescription'
        description: Sas Policies set for the assignment.
      connectors:
        $ref: '#/definitions/ResourceSetDescription'
        description: Connectors set for the assignment.
      views:
        $ref: '#/definitions/ResourceSetDescription'
        description: Views set for the assignment.
      relationshipLinks:
        $ref: '#/definitions/ResourceSetDescription'
        description: The Role assignments set for the relationship links.
      relationships:
        $ref: '#/definitions/ResourceSetDescription'
        description: The Role assignments set for the relationships.
      widgetTypes:
        $ref: '#/definitions/ResourceSetDescription'
        description: Widget types set for the assignment.
      roleAssignments:
        $ref: '#/definitions/ResourceSetDescription'
        description: The Role assignments set for the assignment.
      conflationPolicies:
        $ref: '#/definitions/ResourceSetDescription'
        description: Widget types set for the assignment.
      segments:
        $ref: '#/definitions/ResourceSetDescription'
        description: The Role assignments set for the assignment.
  ProxyResource:
    properties:
      id:
        readOnly: true
        type: string
        description: Resource ID.
      name:
        readOnly: true
        type: string
        description: Resource name.
      type:
        readOnly: true
        type: string
        description: Resource type.
    x-ms-azure-resource: true
    description: Common properties of proxy resource.
  ProvisioningState:
    type: string
    enum:
    - Provisioning
    - Succeeded
    - Expiring
    - Deleting
    - HumanIntervention
    - Failed
    x-ms-enum:
      name: ProvisioningStates
      modelAsString: true
    description: Provisioning state.
  RoleAssignmentResourceFormat:
    description: The Role Assignment resource format.
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/RoleAssignment'
    allOf:
    - $ref: '#/definitions/ProxyResource'
  ResourceSetDescription:
    description: The resource set description.
    properties:
      elements:
        type: array
        items:
          type: string
        description: The elements included in the set.
      exceptions:
        type: array
        items:
          type: string
        description: The elements that are not included in the set, in case elements contains '*' indicating 'all'.
  AssignmentPrincipal:
    description: The AssignmentPrincipal
    required:
    - principalId
    - principalType
    properties:
      principalId:
        type: string
        description: The principal id being assigned to.
      principalType:
        type: string
        description: The Type of the principal ID.
      principalMetadata:
        type: object
        additionalProperties:
          type: string
        description: Other metadata for the principal.
  RoleAssignmentListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/RoleAssignmentResourceFormat'
        description: Results of the list operation.
      nextLink:
        type: string
        description: Link to the next set of results.
    description: The response of list role assignment operation.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'