IAM API

naftiko: 1.0.0-alpha2
info:
  label: IAM API
  description: 'IAM API. 8 operations. Lead operation: Get your Organization''s IAM information. Self-contained Naftiko capability
    covering one Scaleway business surface.'
  tags:
  - Scaleway
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SCALEWAY_API_KEY: SCALEWAY_API_KEY
capability:
  consumes:
  - type: http
    namespace: iam-general
    baseUri: https://api.scaleway.com
    description: IAM API business capability. Self-contained, no shared references.
    resources:
    - name: iam-v1alpha1-check-permissions
      path: /iam/v1alpha1/check-permissions
      operations:
      - name: checkpermissions
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: iam-v1alpha1-organizations-organization_id
      path: /iam/v1alpha1/organizations/{organization_id}
      operations:
      - name: getorganization
        method: GET
        description: Get your Organization's IAM information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organization_id
          in: path
          type: string
          description: ID of the Organization.
          required: true
    - name: iam-v1alpha1-organizations-organization_id-alias
      path: /iam/v1alpha1/organizations/{organization_id}/alias
      operations:
      - name: setorganizationalias
        method: PUT
        description: Set your Organization's alias.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organization_id
          in: path
          type: string
          description: ID of the Organization.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: iam-v1alpha1-organizations-organization_id-login-methods
      path: /iam/v1alpha1/organizations/{organization_id}/login-methods
      operations:
      - name: updateorganizationloginmethods
        method: PATCH
        description: Set your Organization's allowed login methods.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organization_id
          in: path
          type: string
          description: ID of the Organization.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: iam-v1alpha1-users-user_id-connections
      path: /iam/v1alpha1/users/{user_id}/connections
      operations:
      - name: getuserconnections
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: user_id
          in: path
          type: string
          description: ID of the user to list connections for.
          required: true
    - name: iam-v1alpha1-users-user_id-initiate-connection
      path: /iam/v1alpha1/users/{user_id}/initiate-connection
      operations:
      - name: initiateuserconnection
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: user_id
          in: path
          type: string
          description: ID of the user that will be added to your connection.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: iam-v1alpha1-users-user_id-join-connection
      path: /iam/v1alpha1/users/{user_id}/join-connection
      operations:
      - name: joinuserconnection
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: user_id
          in: path
          type: string
          description: User ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: iam-v1alpha1-users-user_id-remove-connection
      path: /iam/v1alpha1/users/{user_id}/remove-connection
      operations:
      - name: removeuserconnection
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: user_id
          in: path
          type: string
          description: ID of the user you want to manage the connection for.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: X-Auth-Token
      value: '{{env.SCALEWAY_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: iam-general-rest
    port: 8080
    description: REST adapter for IAM API. One Spectral-compliant resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/iam/v1alpha1/check-permissions
      name: iam-v1alpha1-check-permissions
      description: REST surface for iam-v1alpha1-check-permissions.
      operations:
      - method: POST
        name: checkpermissions
        description: checkpermissions
        call: iam-general.checkpermissions
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/iam/v1alpha1/organizations/{organization-id}
      name: iam-v1alpha1-organizations-organization-id
      description: REST surface for iam-v1alpha1-organizations-organization_id.
      operations:
      - method: GET
        name: getorganization
        description: Get your Organization's IAM information
        call: iam-general.getorganization
        with:
          organization_id: rest.organization_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/iam/v1alpha1/organizations/{organization-id}/alias
      name: iam-v1alpha1-organizations-organization-id-alias
      description: REST surface for iam-v1alpha1-organizations-organization_id-alias.
      operations:
      - method: PUT
        name: setorganizationalias
        description: Set your Organization's alias.
        call: iam-general.setorganizationalias
        with:
          organization_id: rest.organization_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/iam/v1alpha1/organizations/{organization-id}/login-methods
      name: iam-v1alpha1-organizations-organization-id-login-methods
      description: REST surface for iam-v1alpha1-organizations-organization_id-login-methods.
      operations:
      - method: PATCH
        name: updateorganizationloginmethods
        description: Set your Organization's allowed login methods.
        call: iam-general.updateorganizationloginmethods
        with:
          organization_id: rest.organization_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/iam/v1alpha1/users/{user-id}/connections
      name: iam-v1alpha1-users-user-id-connections
      description: REST surface for iam-v1alpha1-users-user_id-connections.
      operations:
      - method: GET
        name: getuserconnections
        description: getuserconnections
        call: iam-general.getuserconnections
        with:
          user_id: rest.user_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/iam/v1alpha1/users/{user-id}/initiate-connection
      name: iam-v1alpha1-users-user-id-initiate-connection
      description: REST surface for iam-v1alpha1-users-user_id-initiate-connection.
      operations:
      - method: POST
        name: initiateuserconnection
        description: initiateuserconnection
        call: iam-general.initiateuserconnection
        with:
          user_id: rest.user_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/iam/v1alpha1/users/{user-id}/join-connection
      name: iam-v1alpha1-users-user-id-join-connection
      description: REST surface for iam-v1alpha1-users-user_id-join-connection.
      operations:
      - method: POST
        name: joinuserconnection
        description: joinuserconnection
        call: iam-general.joinuserconnection
        with:
          user_id: rest.user_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/iam/v1alpha1/users/{user-id}/remove-connection
      name: iam-v1alpha1-users-user-id-remove-connection
      description: REST surface for iam-v1alpha1-users-user_id-remove-connection.
      operations:
      - method: POST
        name: removeuserconnection
        description: removeuserconnection
        call: iam-general.removeuserconnection
        with:
          user_id: rest.user_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: iam-general-mcp
    port: 9090
    transport: http
    description: MCP adapter for IAM API. One tool per consumed operation, routed inline through this capability's consumes
      block.
    tools:
    - name: checkpermissions
      description: checkpermissions
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: iam-general.checkpermissions
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-your-organization-s-iam-information
      description: Get your Organization's IAM information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: iam-general.getorganization
      with:
        organization_id: tools.organization_id
      outputParameters:
      - type: object
        mapping: $.
    - name: set-your-organization-s-alias
      description: Set your Organization's alias.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: iam-general.setorganizationalias
      with:
        organization_id: tools.organization_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: set-your-organization-s-allowed-login
      description: Set your Organization's allowed login methods.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: iam-general.updateorganizationloginmethods
      with:
        organization_id: tools.organization_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: getuserconnections
      description: getuserconnections
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: iam-general.getuserconnections
      with:
        user_id: tools.user_id
      outputParameters:
      - type: object
        mapping: $.
    - name: initiateuserconnection
      description: initiateuserconnection
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: iam-general.initiateuserconnection
      with:
        user_id: tools.user_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: joinuserconnection
      description: joinuserconnection
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: iam-general.joinuserconnection
      with:
        user_id: tools.user_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: removeuserconnection
      description: removeuserconnection
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: iam-general.removeuserconnection
      with:
        user_id: tools.user_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.