API Reference — subpackage_sso.subpackage_sso/saml

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_sso.subpackage_sso/saml
  description: 'API Reference — subpackage_sso.subpackage_sso/saml. 4 operations. Lead operation: ✨ Retrieve SAML2 Settings.
    Self-contained Naftiko capability covering one Label Studio business surface.'
  tags:
  - Label Studio
  - subpackage_sso.subpackage_sso/saml
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    LABEL_STUDIO_API_KEY: LABEL_STUDIO_API_KEY
capability:
  consumes:
  - type: http
    namespace: label-studio-subpackage-sso-subpackage-sso-saml
    baseUri: http://localhost:8000
    description: API Reference — subpackage_sso.subpackage_sso/saml business capability. Self-contained, no shared references.
    resources:
    - name: api-saml-settings
      path: /api/saml/settings
      operations:
      - name: get
        method: GET
        description: ✨ Retrieve SAML2 Settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: update
        method: POST
        description: ✨ Update SAML2 Settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: reset
        method: DELETE
        description: ✨ Reset SAML2 Settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
    - name: api-saml-settings-validate-metadata-url
      path: /api/saml/settings/validate-metadata-url
      operations:
      - name: validatemetadataurl
        method: POST
        description: ✨ Validate SAML Metadata URL
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.LABEL_STUDIO_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: label-studio-subpackage-sso-subpackage-sso-saml-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_sso.subpackage_sso/saml. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/saml/settings
      name: api-saml-settings
      description: REST surface for api-saml-settings.
      operations:
      - method: GET
        name: get
        description: ✨ Retrieve SAML2 Settings
        call: label-studio-subpackage-sso-subpackage-sso-saml.get
        with:
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: update
        description: ✨ Update SAML2 Settings
        call: label-studio-subpackage-sso-subpackage-sso-saml.update
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: reset
        description: ✨ Reset SAML2 Settings
        call: label-studio-subpackage-sso-subpackage-sso-saml.reset
        with:
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/saml/settings/validate-metadata-url
      name: api-saml-settings-validate-metadata-url
      description: REST surface for api-saml-settings-validate-metadata-url.
      operations:
      - method: POST
        name: validatemetadataurl
        description: ✨ Validate SAML Metadata URL
        call: label-studio-subpackage-sso-subpackage-sso-saml.validatemetadataurl
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: label-studio-subpackage-sso-subpackage-sso-saml-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_sso.subpackage_sso/saml. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: retrieve-saml2-settings
      description: ✨ Retrieve SAML2 Settings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-sso-subpackage-sso-saml.get
      with:
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: update-saml2-settings
      description: ✨ Update SAML2 Settings
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio-subpackage-sso-subpackage-sso-saml.update
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: reset-saml2-settings
      description: ✨ Reset SAML2 Settings
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: label-studio-subpackage-sso-subpackage-sso-saml.reset
      with:
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-saml-metadata-url
      description: ✨ Validate SAML Metadata URL
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: label-studio-subpackage-sso-subpackage-sso-saml.validatemetadataurl
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.