RingCentral API — User Permissions

naftiko: 1.0.0-alpha2
info:
  label: RingCentral API — User Permissions
  description: 'RingCentral API — User Permissions. 6 operations. Lead operation: Get Authorization Profile. Self-contained
    Naftiko capability covering one Ringcentral business surface.'
  tags:
  - Ringcentral
  - User Permissions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    RINGCENTRAL_API_KEY: RINGCENTRAL_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-user-permissions
    baseUri: https://platform.ringcentral.com
    description: RingCentral API — User Permissions business capability. Self-contained, no shared references.
    resources:
    - name: restapi-v1.0-account-accountId-extension-extensionId-authz-profile
      path: /restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile
      operations:
      - name: readauthorizationprofile
        method: GET
        description: Get Authorization Profile
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: targetExtensionId
          in: query
          type: string
    - name: restapi-v1.0-account-accountId-extension-extensionId-authz-profile-check
      path: /restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile/check
      operations:
      - name: checkuserpermission
        method: GET
        description: Check User Permission
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: permissionId
          in: query
          type: string
        - name: targetExtensionId
          in: query
          type: string
    - name: restapi-v1.0-dictionary-permission
      path: /restapi/v1.0/dictionary/permission
      operations:
      - name: listpermissions
        method: GET
        description: List Permissions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: assignable
          in: query
          type: boolean
          description: Specifies whether to return only assignable permissions
        - name: servicePlanId
          in: query
          type: string
          description: Internal identifier of a service plan
    - name: restapi-v1.0-dictionary-permission-category
      path: /restapi/v1.0/dictionary/permission-category
      operations:
      - name: listpermissioncategories
        method: GET
        description: List Permission Categories
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: servicePlanId
          in: query
          type: string
          description: Internal identifier of a service plan
    - name: restapi-v1.0-dictionary-permission-category-permissionCategoryId
      path: /restapi/v1.0/dictionary/permission-category/{permissionCategoryId}
      operations:
      - name: readpermissioncategory
        method: GET
        description: Get Permission Category
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: permissionCategoryId
          in: path
          type: string
          description: Internal identifier of a category
          required: true
    - name: restapi-v1.0-dictionary-permission-permissionId
      path: /restapi/v1.0/dictionary/permission/{permissionId}
      operations:
      - name: readpermission
        method: GET
        description: Get Permission
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: permissionId
          in: path
          type: string
          description: Internal identifier of a user permission
          required: true
    authentication:
      type: bearer
      token: '{{env.RINGCENTRAL_API_KEY}}'
  exposes:
  - type: rest
    namespace: platform-user-permissions-rest
    port: 8080
    description: REST adapter for RingCentral API — User Permissions. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/restapi/v1-0/account/{accountid}/extension/{extensionid}/authz-profile
      name: restapi-v1-0-account-accountid-extension-extensionid-authz-profile
      description: REST surface for restapi-v1.0-account-accountId-extension-extensionId-authz-profile.
      operations:
      - method: GET
        name: readauthorizationprofile
        description: Get Authorization Profile
        call: platform-user-permissions.readauthorizationprofile
        with:
          targetExtensionId: rest.targetExtensionId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/restapi/v1-0/account/{accountid}/extension/{extensionid}/authz-profile/check
      name: restapi-v1-0-account-accountid-extension-extensionid-authz-profile-check
      description: REST surface for restapi-v1.0-account-accountId-extension-extensionId-authz-profile-check.
      operations:
      - method: GET
        name: checkuserpermission
        description: Check User Permission
        call: platform-user-permissions.checkuserpermission
        with:
          permissionId: rest.permissionId
          targetExtensionId: rest.targetExtensionId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/restapi/v1-0/dictionary/permission
      name: restapi-v1-0-dictionary-permission
      description: REST surface for restapi-v1.0-dictionary-permission.
      operations:
      - method: GET
        name: listpermissions
        description: List Permissions
        call: platform-user-permissions.listpermissions
        with:
          assignable: rest.assignable
          servicePlanId: rest.servicePlanId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/restapi/v1-0/dictionary/permission-category
      name: restapi-v1-0-dictionary-permission-category
      description: REST surface for restapi-v1.0-dictionary-permission-category.
      operations:
      - method: GET
        name: listpermissioncategories
        description: List Permission Categories
        call: platform-user-permissions.listpermissioncategories
        with:
          servicePlanId: rest.servicePlanId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/restapi/v1-0/dictionary/permission-category/{permissioncategoryid}
      name: restapi-v1-0-dictionary-permission-category-permissioncategoryid
      description: REST surface for restapi-v1.0-dictionary-permission-category-permissionCategoryId.
      operations:
      - method: GET
        name: readpermissioncategory
        description: Get Permission Category
        call: platform-user-permissions.readpermissioncategory
        with:
          permissionCategoryId: rest.permissionCategoryId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/restapi/v1-0/dictionary/permission/{permissionid}
      name: restapi-v1-0-dictionary-permission-permissionid
      description: REST surface for restapi-v1.0-dictionary-permission-permissionId.
      operations:
      - method: GET
        name: readpermission
        description: Get Permission
        call: platform-user-permissions.readpermission
        with:
          permissionId: rest.permissionId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-user-permissions-mcp
    port: 9090
    transport: http
    description: MCP adapter for RingCentral API — User Permissions. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-authorization-profile
      description: Get Authorization Profile
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-user-permissions.readauthorizationprofile
      with:
        targetExtensionId: tools.targetExtensionId
      outputParameters:
      - type: object
        mapping: $.
    - name: check-user-permission
      description: Check User Permission
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-user-permissions.checkuserpermission
      with:
        permissionId: tools.permissionId
        targetExtensionId: tools.targetExtensionId
      outputParameters:
      - type: object
        mapping: $.
    - name: list-permissions
      description: List Permissions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-user-permissions.listpermissions
      with:
        assignable: tools.assignable
        servicePlanId: tools.servicePlanId
      outputParameters:
      - type: object
        mapping: $.
    - name: list-permission-categories
      description: List Permission Categories
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-user-permissions.listpermissioncategories
      with:
        servicePlanId: tools.servicePlanId
      outputParameters:
      - type: object
        mapping: $.
    - name: get-permission-category
      description: Get Permission Category
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-user-permissions.readpermissioncategory
      with:
        permissionCategoryId: tools.permissionCategoryId
      outputParameters:
      - type: object
        mapping: $.
    - name: get-permission
      description: Get Permission
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-user-permissions.readpermission
      with:
        permissionId: tools.permissionId
      outputParameters:
      - type: object
        mapping: $.