Oracle Fusion Cloud Applications Roles API

openapi: 3.1.0
info:
  title: Oracle Fusion Cloud Applications Oracle Fusion Common Features REST Absences Roles API
  description: REST APIs for Oracle Fusion Cloud Applications Common features, providing access to shared services such as attachments, flexfields, lookup types, roles, users, security, scheduled processes, announcements, and approval workflows used across all Fusion Cloud application pillars.
  version: 11.13.18.05
  contact:
    name: Oracle Support
    url: https://support.oracle.com
    email: support@oracle.com
  license:
    name: Oracle Cloud Services Agreement
    url: https://www.oracle.com/corporate/contracts/cloud-services/
  termsOfService: https://www.oracle.com/corporate/contracts/cloud-services/
servers:
- url: https://{instance}.oraclecloud.com
  description: Oracle Fusion Cloud Instance
  variables:
    instance:
      default: servername
      description: Your Oracle Cloud instance identifier
security:
- bearerAuth: []
tags:
- name: Roles
  description: Manage security roles
paths:
  /hcmRestApi/scim/Roles:
    get:
      operationId: listRoles
      summary: Oracle Fusion Cloud Applications List roles
      description: Retrieve security roles defined in the application.
      tags:
      - Roles
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Roles retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Role'
                  count:
                    type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
  /hcmRestApi/scim/Roles/{id}:
    get:
      operationId: getRole
      summary: Oracle Fusion Cloud Applications Get a role
      description: Retrieve a specific security role.
      tags:
      - Roles
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Role details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateRole
      summary: Oracle Fusion Cloud Applications Update a role
      description: Update an existing security role definition.
      tags:
      - Roles
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleUpdate'
      responses:
        '200':
          description: Role updated
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    NotFound:
      description: The requested resource was not found
    Unauthorized:
      description: Authentication credentials are missing or invalid
  schemas:
    Role:
      type: object
      properties:
        id:
          type: string
          description: Role identifier
        displayName:
          type: string
          description: Role display name
        description:
          type: string
          description: Role description
        roleCategory:
          type: string
          description: Role category
    RoleUpdate:
      type: object
      properties:
        displayName:
          type: string
        description:
          type: string
  parameters:
    offset:
      name: offset
      in: query
      required: false
      schema:
        type: integer
        default: 0
    limit:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        default: 25
        maximum: 500
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: Oracle Fusion Cloud Applications Common Features REST API Documentation
  url: https://docs.oracle.com/en/cloud/saas/applications-common/26a/farca/index.html