Créer un archiveur

Afficher en Markdown
Crée un archiveur. Réservé aux administrateurs. API expérimentale (susceptible d'évoluer). <Note title="Rôle requis"> Administrateur de la plateforme (back-office Goodflag). Inaccessible aux utilisateurs du tenant. </Note>

Authentification

AuthorizationBasic

Identifiants d’administration, requis pour les endpoints /admin/api et /experimental/admin/api.

Paramètres de chemin

tenantIdstringRequis
L'identifiant du tenant.

Requête

This endpoint expects an object.
namestringRequis
Le nom de la solution d'archivage.
descriptionstringRequis
La description de la solution d'archivage.
archivingSolutionenumRequis

La solution d’archivage à utiliser. Valeurs possibles : cecuritySae, cecurityCfn.

clientIdstringRequis

L’identifiant client utilisé pour l’authentification auprès de la solution d’archivage.

clientSecretstringRequis

Le secret client utilisé pour l’authentification auprès de la solution d’archivage.

baseUrlstringRequis

L’URL de base utilisée pour communiquer avec la solution d’archivage.

endpointAuthenticatestringRequis

L’endpoint d’authentification auprès de la solution d’archivage.

endpointUploadstringRequis
L'endpoint de versement de contenu vers la solution d'archivage.
accountNamestringOptionnel

Le nom de compte associé à la solution d’archivage.

Réponse

L’entité Archiver créée.

idstring
L'identifiant de l'archiveur.
tenantIdstring
L'identifiant du tenant auquel appartient l'archiveur.
namestring
Le nom de la solution d'archivage.
descriptionstring
La description de la solution d'archivage.
archivingSolutionstring

La solution d’archivage à utiliser. Certains paramètres dépendent de la solution. Valeurs possibles : cecuritySae : [name, description, archivingSolution, clientId, clientSecret, accountName, baseUrl, endpointAuthenticate, endpointUpload] ; cecurityCfn : [name, description, archivingSolution, clientId, clientSecret, baseUrl, endpointAuthenticate, specificInfo].

clientIdstring

L’identifiant client utilisé pour l’authentification auprès de la solution d’archivage.

clientSecretstring

Le secret client utilisé pour l’authentification auprès de la solution d’archivage.

baseUrlstring

L’URL de base utilisée pour communiquer avec la solution d’archivage.

endpointAuthenticatestring

L’endpoint d’authentification auprès de la solution d’archivage.

endpointUploadstring
L'endpoint de versement de contenu vers la solution d'archivage.
createddouble

La date de création de l’entité.

updateddouble

La date de dernière modification de l’entité.

accountNamestringOptionnel

Le nom de compte associé à la solution d’archivage.

specificInfostringOptionnel

Informations propres à la solution d’archivage. Valeurs possibles : cecuritySae : null ; cecurityCfn : [cfecID, safeID, realm].

Erreurs

400
Bad Request Error
403
Forbidden Error