swagger: '2.0'
info:
  version: '2.0'
  title: access-control-policy-groups
consumes:
  - application/json
produces:
  - application/json
paths:
  /access-control-policy-groups:
    get:
      tags:
        - access-control-policy-groups
      description: Get a collection of access control policy groups.
      operationId: getAccessControlPolicyGroups
      parameters:
        - name: id
          in: query
          description: The unique numeric ID for identifying the access control policy group.
          required: false
          type: integer
          format: int32
        - name: organizationId
          in: query
          description: The unique numeric ID for identifying the organization that owns the access control policy group.
          required: false
          type: integer
          format: int64
        - name: policyGroupName
          in: query
          description: The name of the access control policy group.
          required: false
          type: string
        - name: offset
          in: query
          description: 'The position within the resulting dataset where the query begins returning item records. If the offset is "5", the records that returned begin with the sixth record that matches the query parameters. If the offset is "0", the records that are returned begin with the first record that matches the query parameters.'
          required: false
          type: integer
          format: int32
        - name: limit
          in: query
          description: The maximum number of records to return.
          required: false
          type: integer
          format: int32
        - name: fields
          in: query
          description: 'The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.'
          required: false
          type: string
        - name: expand
          in: query
          description: 'The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.'
          required: false
          type: string
        - name: sort
          in: query
          description: 'The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.'
          required: false
          type: string
      responses:
        '200':
          description: A collection of access control policy groups.
          schema:
            $ref: '#/definitions/AccessControlPolicyGroupCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
  '/access-control-policy-groups/{id}':
    get:
      tags:
        - access-control-policy-groups
      description: Get an access control policy group by ID.
      operationId: getAccessControlPolicyGroupById
      parameters:
        - name: fields
          in: query
          description: 'The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.'
          required: false
          type: string
        - name: expand
          in: query
          description: 'The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.'
          required: false
          type: string
        - name: sort
          in: query
          description: 'The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.'
          required: false
          type: string
      responses:
        '200':
          description: A group of access control policies.
          schema:
            $ref: '#/definitions/AccessControlPolicyGroup'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    parameters:
      - name: id
        in: path
        description: The unique numeric ID for identifying the access control policy group.
        required: true
        type: integer
        format: int32
  '/access-control-policy-groups/{id}/access-control-policy-group-subscriptions':
    get:
      tags:
        - access-control-policy-groups
      description: ''
      operationId: getAccessControlPolicyGroupSubscriptionsOfAccessControlPolicyGroup
      parameters:
        - name: offset
          in: query
          description: 'The position within the resulting dataset where the query begins returning item records. If the offset is "5", the records that returned begin with the sixth record that matches the query parameters. If the offset is "0", the records that are returned begin with the first record that matches the query parameters.'
          required: false
          type: integer
          format: int32
        - name: limit
          in: query
          description: The maximum number of records to return.
          required: false
          type: integer
          format: int32
        - name: fields
          in: query
          description: 'The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.'
          required: false
          type: string
        - name: expand
          in: query
          description: 'The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.'
          required: false
          type: string
        - name: sort
          in: query
          description: 'The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.'
          required: false
          type: string
      responses:
        '200':
          description: A collection of policy group subscriptions.
          schema:
            $ref: '#/definitions/AccessControlPolicyGroupSubscriptionCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    parameters:
      - name: id
        in: path
        description: The unique numeric ID for identifying the access control policy group.
        required: true
        type: integer
        format: int32
definitions:
  Link:
    type: object
    properties:
      href:
        type: string
        format: uri
        description: The URL of the link.
    description: Links to related resources.
  Error:
    type: object
    properties:
      code:
        type: string
        description: The error message code.
      message:
        type: string
        description: The error message.
      messageKey:
        type: string
        description: The error message key.
      messageArguments:
        type: array
        description: The arguments used to construct the error message.
        items:
          type: object
      correlationId:
        type: string
        description: The unique identifier for the request.
      locale:
        type: string
        description: The locale of the error message.
    description: The error message item model.
  ErrorResponseContainer:
    type: object
    properties:
      requestId:
        type: string
        description: The request identifier.
      errors:
        type: array
        description: The errors.
        items:
          $ref: '#/definitions/Error'
    description: The error message model.
  AccessControlPolicyGroup:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: The unique numeric ID for identifying the access control policy group.
      organizationId:
        type: integer
        format: int64
        description: The unique numeric ID for identifying the organization that owns the access control policy group.
      policyGroupName:
        type: string
        description: The name of the access control policy group.
      links:
        type: object
        description: Links to related resources.
        properties:
          access-control-policy-group-subscriptions:
            type: object
            description: ''
            properties:
              href:
                type: string
                description: The URL of the link.
    description: A group of access control policies.
  AccessControlPolicyGroupCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/AccessControlPolicyGroup'
    description: A collection of access control policy groups.
  AccessControlPolicyGroupSubscription:
    type: object
    properties:
      accessControlPolicyGroupId:
        type: integer
        format: int32
        description: The unique numeric ID for identifying the access control policy group to which the organization is subscribing to.
      organizationId:
        type: integer
        format: int64
        description: The unique numeric ID for identifying the organization that is subscribing to a policy group.
    description: The access control policy group to which an organization is subscribing to.
  AccessControlPolicyGroupSubscriptionCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/AccessControlPolicyGroupSubscription'
    description: A collection of policy group subscriptions.
