m3ter API — OrgUsers

naftiko: 1.0.0-alpha2
info:
  label: m3ter API — OrgUsers
  description: 'm3ter API — OrgUsers. 6 operations. Lead operation: List OrgUsers. Self-contained Naftiko capability covering
    one M3ter business surface.'
  tags:
  - M3ter
  - OrgUsers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    M3TER_API_KEY: M3TER_API_KEY
capability:
  consumes:
  - type: http
    namespace: m3ter-orgusers
    baseUri: https://api.m3ter.com
    description: m3ter API — OrgUsers business capability. Self-contained, no shared references.
    resources:
    - name: organizations-orgId-users
      path: /organizations/{orgId}/users
      operations:
      - name: listorgusers
        method: GET
        description: List OrgUsers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
        - name: pageSize
          in: query
          type: integer
          description: Specifies the maximum number of OrgUsers to retrieve per page.
        - name: nextToken
          in: query
          type: string
          description: The `nextToken` for multi-page retrievals. It is used to fetch the next page of OrgUsers in a paginated
            list.
        - name: ids
          in: query
          type: array
          description: list of ids to retrieve
    - name: organizations-orgId-users-id
      path: /organizations/{orgId}/users/{id}
      operations:
      - name: getorguser
        method: GET
        description: Retrieve OrgUser
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier (UUID) of the Organization User to retrieve.
          required: true
        - name: orgId
          in: path
          type: string
          description: UUID of the organization.
          required: true
      - name: putorguser
        method: PUT
        description: Update OrgUser
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier (UUID) of the OrgUser to update.
          required: true
        - name: orgId
          in: path
          type: string
          description: UUID of the organization.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-orgId-users-id-password-resend
      path: /organizations/{orgId}/users/{id}/password/resend
      operations:
      - name: adminresendtemppass
        method: PUT
        description: Resend temporary password for user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the organization
          required: true
        - name: id
          in: path
          type: string
          description: UUID of the user
          required: true
    - name: organizations-orgId-users-id-permissions
      path: /organizations/{orgId}/users/{id}/permissions
      operations:
      - name: getorguserpermissions
        method: GET
        description: Retrieve OrgUser Permissions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
        - name: id
          in: path
          type: string
          description: The unique identifier (UUID) of the user whose permissions you want to retrieve.
          required: true
        - name: pageSize
          in: query
          type: integer
          description: Specifies the maximum number of Permission Policies to retrieve per page.
        - name: nextToken
          in: query
          type: string
          description: The `nextToken` for multi-page retrievals. It is used to fetch the next page of Permission Policies
            in a paginated list.
    - name: organizations-orgId-users-id-usergroups
      path: /organizations/{orgId}/users/{id}/usergroups
      operations:
      - name: getorgusergroups
        method: GET
        description: Retrieve OrgUser Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
        - name: id
          in: path
          type: string
          description: The unique identifier (UUID) of the user.
          required: true
        - name: pageSize
          in: query
          type: integer
          description: Specifies the maximum number of User Groups to retrieve per page.
        - name: nextToken
          in: query
          type: string
          description: The `nextToken` for multi-page retrievals. It is used to fetch the next page of User Groups in a paginated
            list.
    authentication:
      type: bearer
      token: '{{env.M3TER_API_KEY}}'
  exposes:
  - type: rest
    namespace: m3ter-orgusers-rest
    port: 8080
    description: REST adapter for m3ter API — OrgUsers. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/organizations/{orgid}/users
      name: organizations-orgid-users
      description: REST surface for organizations-orgId-users.
      operations:
      - method: GET
        name: listorgusers
        description: List OrgUsers
        call: m3ter-orgusers.listorgusers
        with:
          orgId: rest.orgId
          pageSize: rest.pageSize
          nextToken: rest.nextToken
          ids: rest.ids
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{orgid}/users/{id}
      name: organizations-orgid-users-id
      description: REST surface for organizations-orgId-users-id.
      operations:
      - method: GET
        name: getorguser
        description: Retrieve OrgUser
        call: m3ter-orgusers.getorguser
        with:
          id: rest.id
          orgId: rest.orgId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putorguser
        description: Update OrgUser
        call: m3ter-orgusers.putorguser
        with:
          id: rest.id
          orgId: rest.orgId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{orgid}/users/{id}/password/resend
      name: organizations-orgid-users-id-password-resend
      description: REST surface for organizations-orgId-users-id-password-resend.
      operations:
      - method: PUT
        name: adminresendtemppass
        description: Resend temporary password for user
        call: m3ter-orgusers.adminresendtemppass
        with:
          orgId: rest.orgId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{orgid}/users/{id}/permissions
      name: organizations-orgid-users-id-permissions
      description: REST surface for organizations-orgId-users-id-permissions.
      operations:
      - method: GET
        name: getorguserpermissions
        description: Retrieve OrgUser Permissions
        call: m3ter-orgusers.getorguserpermissions
        with:
          orgId: rest.orgId
          id: rest.id
          pageSize: rest.pageSize
          nextToken: rest.nextToken
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{orgid}/users/{id}/usergroups
      name: organizations-orgid-users-id-usergroups
      description: REST surface for organizations-orgId-users-id-usergroups.
      operations:
      - method: GET
        name: getorgusergroups
        description: Retrieve OrgUser Groups
        call: m3ter-orgusers.getorgusergroups
        with:
          orgId: rest.orgId
          id: rest.id
          pageSize: rest.pageSize
          nextToken: rest.nextToken
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: m3ter-orgusers-mcp
    port: 9090
    transport: http
    description: MCP adapter for m3ter API — OrgUsers. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-orgusers
      description: List OrgUsers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-orgusers.listorgusers
      with:
        orgId: tools.orgId
        pageSize: tools.pageSize
        nextToken: tools.nextToken
        ids: tools.ids
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-orguser
      description: Retrieve OrgUser
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-orgusers.getorguser
      with:
        id: tools.id
        orgId: tools.orgId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-orguser
      description: Update OrgUser
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: m3ter-orgusers.putorguser
      with:
        id: tools.id
        orgId: tools.orgId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: resend-temporary-password-user
      description: Resend temporary password for user
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: m3ter-orgusers.adminresendtemppass
      with:
        orgId: tools.orgId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-orguser-permissions
      description: Retrieve OrgUser Permissions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-orgusers.getorguserpermissions
      with:
        orgId: tools.orgId
        id: tools.id
        pageSize: tools.pageSize
        nextToken: tools.nextToken
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-orguser-groups
      description: Retrieve OrgUser Groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-orgusers.getorgusergroups
      with:
        orgId: tools.orgId
        id: tools.id
        pageSize: tools.pageSize
        nextToken: tools.nextToken
      outputParameters:
      - type: object
        mapping: $.