> ## Documentation Index
> Fetch the complete documentation index at: https://developers.marko.fr/llms.txt
> Use this file to discover all available pages before exploring further.

# Suspendre un utilisateur

> Suspend un utilisateur activé de l'entité.

**Scope requis :** `users:write`. [Scopes et délégation](/scopes-and-delegation).



## OpenAPI

````yaml /openapi.json post /users/{user_id}/actions/suspend
openapi: 3.1.0
info:
  title: MARKO External Partner API
  version: v1
  description: >-
    Stable external API contract for the live environment.


    Authentication flow for partner integrations:

    1. Generate an API key from the MARKO entity admin API section.

    2. Keep the raw API secret server-side and use it only to sign `POST
    /v1/auth/token`.

    3. Build the canonical message
    `MARKO-EXTERNAL-API-TOKEN-V1\n{key_id}\n{timestamp}\n{nonce}`.

    4. Sign that message with HMAC-SHA256 and send the hex signature with
    `key_id`, `timestamp` and `nonce`.

    5. Use the returned short-lived bearer on business endpoints as
    `Authorization: Bearer <access_token>`.

    The raw API secret must never be sent on business endpoints.


    This public contract intentionally excludes beta endpoints.


    Référence enrichie pour les développeurs et les assistants IA. Exemples
    synthétiques; les champs sont extraits des modèles et sérialiseurs de la
    version indiquée dans x-documentation-provenance.
servers:
  - url: https://partner-api.marko.fr/v1
security:
  - BearerAuth: []
tags:
  - name: auth
    x-group: Authentification
  - name: entity
    x-group: Entité
  - name: portfolio
    x-group: Portefeuille
  - name: deals
    x-group: Deals
  - name: fonds
    x-group: Fonds
  - name: spvs
    x-group: SPV
  - name: operations
    x-group: Opérations
  - name: taxonomies
    x-group: Taxonomies
  - name: import-jobs
    x-group: Imports par lot
  - name: comments
    x-group: Commentaires
  - name: documents
    x-group: Documents
  - name: users
    x-group: Utilisateurs
  - name: settings
    x-group: Paramètres
  - name: rcci
    x-group: Conformité RCCI
  - name: field-definitions
    x-group: Champs métier
  - name: search
    x-group: Recherche
  - name: operateurs
    x-group: Opérateurs
  - name: alerts
    x-group: Alertes
  - name: notifications
    x-group: Notifications
  - name: calendar
    x-group: Calendrier
  - name: enrichment
    x-group: Enrichissement SIREN
  - name: reports
    x-group: Exports
  - name: reporting
    x-group: Templates de reporting
  - name: workflows
    x-group: Workflows et extraction IA
  - name: tasks
    x-group: Tâches
externalDocs:
  description: Download the matching Postman collection.
  url: /v1/postman.json
paths:
  /users/{user_id}/actions/suspend:
    post:
      tags:
        - users
      summary: Suspendre un utilisateur
      description: >-
        Suspend un utilisateur activé de l'entité.


        **Scope requis :** `users:write`. [Scopes et
        délégation](/scopes-and-delegation).
      operationId: users_suspend
      parameters:
        - in: path
          name: user_id
          required: true
          schema:
            type: string
            title: User Id
          example: usr_001
          description: Identifiant utilisateur MARKO; il n'est pas nécessairement un UUID.
        - in: header
          name: X-Request-ID
          required: false
          description: >-
            Partner-generated correlation identifier echoed in logs and error
            payloads.
          schema:
            type: string
          example: marko-users-suspend
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityAdminUserResponse'
              example:
                id: usr_001
                email: integration@example.com
                name: Exemple MARKO
                status: suspended
                created_at: '2026-10-01T10:00:00Z'
                updated_at: '2026-10-01T10:00:00Z'
                is_pending_invite: false
          headers:
            Idempotency-Key:
              schema:
                type: string
              description: Clé d'idempotence utilisée pour l'action.
            X-Marko-Idempotency-Key-Source:
              schema:
                type: string
                enum:
                  - client
                  - server
              description: Origine de la clé utilisée.
            X-Marko-Idempotency-TTL-Seconds:
              schema:
                type: integer
              description: Durée de rétention annoncée pour cette action, en secondes.
        '401':
          description: Authentication required
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Unauthorized
                status: 401
                detail: A valid bearer token is required.
                request_id: req_example_partner_call
        '403':
          description: Scope, route or IP restriction
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Forbidden
                status: 403
                detail: The API key does not allow this operation.
                request_id: req_example_partner_call
        '404':
          description: >-
            Not Found — refus déclaré dans le handler ou un helper de cette
            route.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: Validation failed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Unprocessable Content
                status: 422
                detail: The request payload or parameters are invalid.
                request_id: req_example_partner_call
        '429':
          description: Rate limit or progressive ban
          headers:
            Retry-After:
              description: Cooldown in seconds before retrying the request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Too Many Requests
                status: 429
                detail: The request rate limit was exceeded.
                request_id: req_example_partner_call
        '500':
          description: Unexpected server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Internal Server Error
                status: 500
                detail: An unexpected server error occurred.
                request_id: req_example_partner_call
      deprecated: false
      security:
        - BearerAuth: []
components:
  schemas:
    EntityAdminUserResponse:
      properties:
        id:
          type: string
          title: Id
          description: Identifiant MARKO de la ressource.
        email:
          type: string
          title: Email
          description: Adresse e-mail du compte utilisateur.
        name:
          type: string
          title: Name
          description: >-
            Nom de la ressource. Les recherches exactes et partielles sont
            décrites au niveau de la route.
        first_name:
          anyOf:
            - type: string
            - type: 'null'
          title: First Name
          description: Prénom de l'utilisateur.
        last_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Name
          description: Nom de famille de l'utilisateur.
        image:
          anyOf:
            - type: string
            - type: 'null'
          title: Image
          description: Image de profil de l'utilisateur, si elle est renseignée.
        role:
          type: string
          title: Role
          default: client
          description: Rôle du compte utilisateur dans l'entité.
        status:
          type: string
          title: Status
          default: pending
          description: >-
            État du compte utilisateur ou du retrait d'accès; distinct du rôle
            dans l'entité.
        entity_slug:
          anyOf:
            - type: string
            - type: 'null'
          title: Entity Slug
          description: Entité à laquelle l'intégration est rattachée.
        email_verified:
          type: boolean
          title: Email Verified
          default: false
          description: Indique si l'adresse e-mail du compte a été vérifiée.
        approved_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Approved By
          description: Identifiant de l'utilisateur qui a approuvé ce compte.
        invitation_expires_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Invitation Expires At
          description: Date d'expiration de l'invitation du compte.
        invitation_delivery:
          anyOf:
            - $ref: '#/components/schemas/InvitationDeliveryResponse'
            - type: 'null'
          description: >-
            Résultat de l'envoi de l'invitation; la création du compte ne
            garantit pas la livraison de l'e-mail.
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Date de création au format ISO 8601.
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: Date de dernière modification au format ISO 8601.
        is_pending_invite:
          type: boolean
          title: Is Pending Invite
          readOnly: true
          description: Indique si l'utilisateur doit encore activer son invitation.
      type: object
      required:
        - id
        - email
        - name
        - created_at
        - updated_at
        - is_pending_invite
      title: EntityAdminUserResponse
      description: User representation for entity admin endpoints.
    ProblemDetails:
      type: object
      required:
        - title
        - status
        - detail
      properties:
        type:
          type: string
          default: about:blank
          description: >-
            URI identifiant le type de problème; about:blank lorsque seul le
            statut HTTP le caractérise.
        title:
          type: string
          description: Titre affiché pour l'événement ou le problème.
        status:
          type: integer
          description: Statut HTTP de la réponse d'erreur.
        detail:
          type: string
          description: Informations détaillées sur le problème ou le dossier.
        request_id:
          type: string
          description: Identifiant de corrélation pour le diagnostic de la requête.
        scope:
          type: string
          description: Scope concerné par le refus d'accès, lorsqu'il est renseigné.
        route_id:
          type: string
          description: Identifiant de la route concernée par le problème.
        reason_code:
          type: string
          description: >-
            Code structuré du motif de refus; préférable au texte du message
            pour le diagnostic.
    InvitationDeliveryResponse:
      properties:
        reference:
          type: string
          title: Reference
          description: Référence de suivi de la livraison de l'invitation.
        status:
          type: string
          enum:
            - preparing
            - queued
            - sending
            - sent
            - failed
            - suppressed
            - superseded
          title: Status
          description: >-
            État de livraison de l'invitation; ne prouve pas que l'utilisateur a
            activé son compte.
        retryable:
          type: boolean
          title: Retryable
          description: >-
            Indique si l'échec de livraison de l'invitation peut faire l'objet
            d'une reprise.
        support:
          $ref: '#/components/schemas/InvitationDeliverySupportResponse'
          description: >-
            Informations de suivi disponibles pour diagnostiquer la livraison de
            l'invitation.
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
          description: Date de dernière modification au format ISO 8601.
      type: object
      required:
        - reference
        - status
        - retryable
      title: InvitationDeliveryResponse
    InvitationDeliverySupportResponse:
      properties:
        status:
          type: string
          enum:
            - created
            - existing
            - pending
            - unavailable
            - not_applicable
          title: Status
          default: not_applicable
          description: >-
            État de livraison de l'invitation; ne prouve pas que l'utilisateur a
            activé son compte.
        reference:
          anyOf:
            - type: string
            - type: 'null'
          title: Reference
          description: Référence de suivi de la livraison de l'invitation.
      type: object
      title: InvitationDeliverySupportResponse
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: MARKO short-lived bearer
      description: >-
        Use the `access_token` returned by `POST /v1/auth/token`. Do not send
        the raw API secret on business endpoints.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.