> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.goodflag.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.goodflag.com/_mcp/server.

# Consulter un tenant

GET https://workflow-manager/api/tenants/{tenantId}

Renvoie un tenant existant.

`tenantManager`

Reference: https://docs.goodflag.com/wm/api-reference/documentation-api/token-portail/tenants/retrieve-tenant

## Authentication

- `Authorization` header (bearer token, required) — Authentification Bearer par jeton utilisateur ou jeton d'accès : `Authorization: Bearer <token>`.

## Request

### Path parameters

- `tenantId` (string, required) — L'identifiant du tenant.

## Response

### 200

Consulter un tenant

- `activateExternalArchive` (boolean, required) — Indique si les fichiers de preuve sont versés dans un système d'archivage externe lors de l'archivage du parapheur.
- `allowCommentsInSteps` (boolean, required) — Indique si l'autorisation des commentaires est gérée par le gestionnaire du parapheur.
- `allowConsolidation` (boolean, required) — Indique si la consolidation du parapheur est activée.
- `allowExternalArchive` (boolean, required) — Indique si le tenant est autorisé à verser dans un système d'archivage externe.
- `allowWatchers` (boolean, required) — Indique si l'autorisation des observateurs est gérée par le gestionnaire du parapheur.
- `allowedTenantStatus` (list of string, required) — Les statuts vers lesquels le tenant est autorisé à basculer.
- `attachmentExtensions` (list of string, required) — Les extensions de fichier autorisées pour les pièces jointes des parapheurs.
- `certificateEvidenceLanguage` (string, required) — La langue du certificat de preuve.
- `createUserOnLogin` (boolean, required) — Indique si les utilisateurs sont créés automatiquement à la première connexion.
- `created` (long, required) — La date de création de l'entité.
- `darkColor` (string, required) — La couleur sombre du portail.
- `defaultAllowComments` (boolean, required) — La valeur par défaut de l'autorisation des commentaires dans les étapes.
- `defaultCountry` (string, required) — Le pays par défaut des nouveaux utilisateurs, lorsque le fournisseur d'identité ne le fournit pas. Sans valeur spécifiée, le pays par défaut est FR.
- `defaultGroupId` (string, required) — L'identifiant du groupe par défaut du tenant.
- `domainName` (string, required) — Le nom de domaine du tenant.
- `downloadLinkTokenValidityDays` (long, required, default: 3650) — Durée de validité du jeton de lien de téléchargement, en jours.
- `forceFlattenPdf` (boolean, required) — Indique si les champs de signature existants sont aplatis lors de l'envoi des PDF.
- `id` (string, required) — L'identifiant du tenant.
- `idpBaseUrl` (string, required) — URL de base du fournisseur d'identité OpenID Connect.
- `idpClientId` (string, required) — Identifiant client (client ID) du fournisseur d'identité OpenID Connect.
- `idpClientSecret` (string, required) — Secret client du fournisseur d'identité OpenID Connect.
- `idpScope` (string, required) — Scope du fournisseur d'identité OpenID Connect.
- `idpType` (string, required) — Type de fournisseur d'identité.
- `lockDocumentsAfterFirstValidation` (boolean, required) — Indique si les documents sont verrouillés après la première validation.
- `loginTokenTtl` (long, required) — La durée de validité du jeton de connexion au portail, en millisecondes.
- `maxAttachments` (long, required, default: 10) — Le nombre maximal de pièces jointes autorisé par le portail.
- `maxDocumentSize` (long, required, default: 10485760) — La taille maximale de document autorisée par le portail, en octets. Au-delà de 104857600 octets, une option payante est nécessaire.
- `maxDocuments` (long, required, default: 200) — Le nombre maximal de documents à signer autorisé par le portail.
- `primaryColor` (string, required) — La couleur principale du portail.
- `secondaryColor` (string, required) — La couleur secondaire du portail.
- `smtpSenderName` (string, required) — Le nom d'expéditeur des emails de notification.
- `technicalContactUrl` (string, required) — L'URL du contact technique affichée dans le portail.
- `updated` (long, required) — La date de dernière modification de l'entité.
- `allowSignatureOnHigherSignatureLevel` (boolean, optional) — Autorise la signature d'un document qui porte déjà une signature de niveau supérieur. Par exemple, permet de cosigner en LT un document portant une signature LTA.
- `allowSingleSignerMode` (boolean, optional) — Indique si le mode signataire unique est autorisé pour les parapheurs de ce tenant.
- `allowSupportingDocumentsRequest` (boolean, optional) — Indique si les pièces justificatives sont autorisées.
- `consentVersion` (string, optional)
- `createUserOnLoginGroupId` (string, optional) — Identifiant du groupe sélectionné lorsque l'option de création de l'utilisateur à la première connexion est activée.
- `logoResourceId` (string, optional) — L'identifiant de la ressource image du logo.
- `requireSupportingDocuments` (boolean, optional) — Indique si les pièces justificatives sont requises pour les parapheurs de ce tenant.
- `tenantStatus` (string, optional) — Le statut du tenant.
- `visual` (object, optional)
  - `allowVisual` (boolean, optional) — Indique si l'ajout d'un visuel attestant de la signature sur les pages du document est autorisé.
  - `text` (string, optional) — Le visuel, sous forme de texte. Il doit contenir \{\{workflowId}}.
- `organizationName` (string, optional) — Le nom de l'organisation du tenant.
- `externalArchivingParameters` (object, optional) — Paramètres d'archivage externe du parapheur archivé.
  - `archiverId` (string, optional) — Identifiant de la configuration d'archiveur externe.
  - `filesToArchive` (list of enum, optional) — Fichiers ciblés par l'archivage. Valeurs possibles : evidenceFiles, signedDocuments.
    - Allowed values: `evidenceFiles`, `signedDocuments`
  - `metadata` (list of object, optional) — Métadonnée à associer au parapheur archivé.
    - `name` (string, optional) — Nom de la métadonnée à associer au parapheur archivé.
    - `value` (string, optional) — Metadata value to associate with the archived workflow. Values available are: \{\{workflowName}}, \{\{workflowId}}, \{\{archivedAt}} (date + time in ISO 8601 format)
- `jobOperation` (string, optional) — L'opération de tâche en cours d'exécution.

## Errors

### 403 Forbidden Error

AuthenticatedUserDisabled : L'utilisateur authentifié est désactivé. ; MissingBearerToken : Un jeton Bearer est requis. ; TenantInactive : Le tenant est inactif et n'autorise aucune opération. ; UserGroupDisabled : Le groupe de l'utilisateur spécifié est désactivé. ; UserNotAllowed : L'utilisateur authentifié n'est pas autorisé à effectuer cette opération.

- `status` (integer, required) — Le code de statut HTTP.
- `error` (string, required) — Le message de statut HTTP.
- `message` (string, required) — Le message d'erreur.
- `code` (string, required) — Le code d'erreur.

## Examples

**Response**

```json
{
  "activateExternalArchive": false,
  "allowCommentsInSteps": true,
  "allowConsolidation": true,
  "allowExternalArchive": false,
  "allowWatchers": true,
  "allowedTenantStatus": [
    "active",
    "inactive",
    "trial"
  ],
  "attachmentExtensions": [],
  "certificateEvidenceLanguage": "en",
  "createUserOnLogin": true,
  "created": 1782821280360,
  "darkColor": "#104670",
  "defaultAllowComments": true,
  "defaultCountry": "FR",
  "defaultGroupId": "grp_ExUUECizVJs8KVq7nCwhwMR1",
  "domainName": "gaylord.name",
  "downloadLinkTokenValidityDays": 3650,
  "forceFlattenPdf": true,
  "id": "ten_Hm5gqY6oKADYdg9cjhsVbQDH",
  "idpBaseUrl": "https://accounts.google.com/",
  "idpClientId": "4192",
  "idpClientSecret": "****************",
  "idpScope": "openid email profile",
  "idpType": "google",
  "lockDocumentsAfterFirstValidation": false,
  "loginTokenTtl": 3600000,
  "maxAttachments": 10,
  "maxDocumentSize": 10485760,
  "maxDocuments": 200,
  "primaryColor": "#208cdf",
  "secondaryColor": "#4ca3e5",
  "smtpSenderName": "My application",
  "technicalContactUrl": "https://support.lex-persona.com",
  "updated": 1782821280360,
  "allowSignatureOnHigherSignatureLevel": false,
  "allowSingleSignerMode": true,
  "allowSupportingDocumentsRequest": false,
  "consentVersion": "V2",
  "logoResourceId": "res_AbTLeTHt8x9jWD3ZeBHVH33C",
  "requireSupportingDocuments": false,
  "tenantStatus": "trial",
  "visual": {
    "allowVisual": false
  }
}
```

**SDK Code**

```python Requête réussie.
import requests

url = "https://workflow-manager/api/tenants/tenantId"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Requête réussie.
const url = 'https://workflow-manager/api/tenants/tenantId';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Requête réussie.
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://workflow-manager/api/tenants/tenantId"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Requête réussie.
require 'uri'
require 'net/http'

url = URI("https://workflow-manager/api/tenants/tenantId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Requête réussie.
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://workflow-manager/api/tenants/tenantId")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Requête réussie.
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://workflow-manager/api/tenants/tenantId', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Requête réussie.
using RestSharp;

var client = new RestClient("https://workflow-manager/api/tenants/tenantId");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Requête réussie.
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://workflow-manager/api/tenants/tenantId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```