Britive Resource Profiles - Policies API

openapi: 3.2.0
info:
  title: Britive Services API Documentation Resource Profiles - Policies API
  version: v1
  description: API documentation for Users, Tags, Identity providers, Applications, Reporting, Audit logs, Tenants, SSO, Profiles, Password policies, MFA, Access Builder Settings, etc.
servers:
- url: https://{tenantURL}
  description: The primary server
  variables:
    tenantURL:
      default: test.britive-app.com
      description: The host of the server
security:
- bearerAuth: []
tags:
- name: Resource Profiles - Policies
  description: Manage Resource Profiles Policies
paths:
  /api/resource-manager/profiles/{profileId}/policies:
    post:
      tags:
      - Resource Profiles - Policies
      summary: Add policy to profile to grant resources to end user
      operationId: AddPolicyToProfile
      parameters:
      - name: profileId
        in: path
        description: Id of the profile to add policy
        required: true
        schema:
          type: string
      requestBody:
        description: Add policy to a profile
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourcePolicyDto'
      responses:
        '201':
          description: policy got created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourcePolicyDto'
    get:
      tags:
      - Resource Profiles - Policies
      summary: Get all policies associated to a profile
      operationId: geAllPolicies
      parameters:
      - name: profileId
        in: path
        description: Id of profile to get policies
        required: true
        schema:
          type: string
      - name: filter
        in: query
        description: Parameter to filter policy by name
        required: false
        schema:
          type: string
          example: name eq policy1
      responses:
        '200':
          description: retrieved policies of profile successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ResourcePolicyDto'
        '404':
          description: Not Found
  /api/resource-manager/profiles/{profileId}/policies/order:
    post:
      tags:
      - Resource Profiles - Policies
      summary: Set orders for policies associated with an entity
      operationId: setResourceProfilePolicyOrdering
      parameters:
      - name: profileId
        in: path
        required: true
        description: ID of the profile
        schema:
          type: string
      requestBody:
        required: true
        description: List of policy IDs and their corresponding order values
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PolicyOrderingDto'
      responses:
        '200':
          description: Policy order successfully updated
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PolicyOrderingDto'
        '400':
          description: Bad Request
  /api/resource-manager/profiles/{profileId}/policies/{policyId}:
    delete:
      tags:
      - Resource Profiles - Policies
      summary: Delete  profile policy
      operationId: deletePolicy
      parameters:
      - name: profileId
        in: path
        description: Id of profile to delete policy
        required: true
        schema:
          type: string
      - name: policyId
        in: path
        description: policy Id to delete
        required: true
        schema:
          type: string
      responses:
        '204':
          description: profile got deleted successfully
        '404':
          description: Not Found
    get:
      tags:
      - Resource Profiles - Policies
      summary: Get policy details for a given policy id
      operationId: GetPolicyDetails
      parameters:
      - name: profileId
        in: path
        description: Id of profile to add policy
        required: true
        schema:
          type: string
      - name: policyId
        in: path
        description: policy Id to fetch policy details
        required: true
        schema:
          type: string
      - name: compactResponse
        in: query
        description: Policy details in compact json foramt
        required: false
        schema:
          type: boolean
          example: 'true'
      responses:
        '200':
          description: policy retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourcePolicyDto'
        '404':
          description: Not Found
    patch:
      tags:
      - Resource Profiles - Policies
      summary: Update policy details for a given policy id
      operationId: UpdatePolicyDetails
      parameters:
      - name: profileId
        in: path
        description: Id of profile to add policy
        required: true
        schema:
          type: string
      - name: policyId
        in: path
        description: policy ID to update policy details
        required: true
        schema:
          type: string
      requestBody:
        description: update policy details
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourcePolicyDto'
      responses:
        '204':
          description: policy details got updated successfully
        '404':
          description: Not found
components:
  schemas:
    PolicyOrderingDto:
      type: object
      required:
      - id
      - order
      properties:
        id:
          type: string
          description: Unique ID of the policy
        order:
          type: integer
          description: Order value for the policy
          example: '1'
    LabelAssociation:
      type: object
      additionalProperties:
        type: array
        items:
          type: string
    ResourcePolicyDto:
      type: object
      x-exclude-from-codegen: 'true'
      properties:
        id:
          type: string
        name:
          type: string
        isActive:
          type: boolean
        isDraft:
          type: boolean
        isReadOnly:
          type: boolean
        condition:
          type: object
        resource:
          type: string
        accessLevel:
          type: string
        consumer:
          type: string
        members:
          type: array
          items:
            $ref: '#/components/schemas/MemberDto'
        resourceLabels:
          $ref: '#/components/schemas/LabelAssociation'
    MemberDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        memberType:
          type: string
          enum:
          - User
          - Tag
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
x-api-evangelist:
  assembled_from: https://docs.britive.com/apidocs/ (one OpenAPI fragment per operation page, .md variant)
  assembled_on: '2026-08-08'
  fragments: 372
  note: Britive publishes this contract only as per-operation fragments inside its Document360 API reference. This file is the faithful union of those fragments; the verbatim assembly is in openapi/_original/.