1. Vue générale

This API is used to manage customers, tenants, identity providers, users with their profiles and their profiles groups. This is for an internal use only.

1.2. Information de contact

Contact : Direction de la diffusion et des partenariats
Email de contact : contact@programmevitam.fr

1.3. Information de licence

Licence : License to be defined …​
Licence URL : URL not defined.
Conditions de service : Terms of service

1.4. Schéma d’URI

Serveur : localhost
Chemin de base : /

1.5. Tags

  • applications : Applications Management

  • cas : User authentication management for CAS

  • customers : Customers Management

  • externalParameters : External Parameters Internal Controller

  • groups : Profiles Groups Management

  • identityproviders : Identity Providers Management

  • logbooks : logbooks Management

  • owners : Owners Management

  • profiles : Profiles Management

  • status : Status check and autotest

  • subrogations : Subrogation Management

  • tenants : Tenants Management

  • users : Users Management

1.6. Produit

  • application/json

2. Ressources

2.1. Applications

Applications Management

2.1.1. getAll

GET /iam/v1/applications
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Query

embedded
requis

embedded

string

Réponses
Code HTTP Description Schéma

200

OK

< ApplicationDto > array

Exemple de requête HTTP
Requête path
/iam/v1/applications
Requête query
{
  "criteria" : "string",
  "embedded" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "category" : "string",
  "hasCustomerList" : true,
  "hasHighlight" : true,
  "hasTenantList" : true,
  "icon" : "string",
  "id" : "string",
  "identifier" : "string",
  "name" : "string",
  "position" : 0,
  "target" : "string",
  "tooltip" : "string",
  "url" : "string"
} ]

2.2. Cas

User authentication management for CAS

2.2.1. login

POST /iam/v1/cas/login
Paramètres
Type Nom Description Schéma

Body

dto
requis

dto

LoginRequestDto

Réponses
Code HTTP Description Schéma

200

OK

UserDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/cas/login
Requête body
{
  "ip" : "string",
  "password" : "string",
  "surrogate" : "string",
  "username" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "analytics" : {
    "applications" : [ {
      "accessCounter" : 0,
      "applicationId" : "string",
      "lastAccess" : "string"
    } ],
    "lastTenantIdentifier" : 0
  },
  "customerId" : "string",
  "disablingDate" : "string",
  "email" : "string",
  "firstname" : "string",
  "groupId" : "string",
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "language" : "string",
  "lastConnection" : "string",
  "lastname" : "string",
  "level" : "string",
  "mobile" : "string",
  "nbFailedAttempts" : 0,
  "otp" : true,
  "passwordExpirationDate" : "string",
  "phone" : "string",
  "readonly" : true,
  "removingDate" : "string",
  "siteCode" : "string",
  "status" : "string",
  "subrogeable" : true,
  "type" : "string"
}

2.2.2. logout

GET /iam/v1/cas/logout
Paramètres
Type Nom Description Schéma

Query

authToken
requis

authToken

string

Query

superUser
requis

superUser

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Exemple de requête HTTP
Requête path
/iam/v1/cas/logout
Requête query
{
  "authToken" : "string",
  "superUser" : "string"
}

2.2.3. changePassword

POST /iam/v1/cas/password/change
Paramètres
Type Nom Description Schéma

Header

password
requis

password

string

Header

username
requis

username

string

Réponses
Code HTTP Description Schéma

200

OK

string

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/cas/password/change
Requête header
"string"

2.2.4. getSubrogationsBySuperUserId

GET /iam/v1/cas/subrogations
Paramètres
Type Nom Description Schéma

Query

superUserId
requis

superUserId

string

Réponses
Code HTTP Description Schéma

200

OK

< SubrogationDto > array

Exemple de requête HTTP
Requête path
/iam/v1/cas/subrogations
Requête query
{
  "superUserId" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "date" : "string",
  "id" : "string",
  "status" : "string",
  "superUser" : "string",
  "superUserCustomerId" : "string",
  "surrogate" : "string",
  "surrogateCustomerId" : "string"
} ]

2.2.5. getUserByEmail

GET /iam/v1/cas/users
Paramètres
Type Nom Description Schéma

Query

email
requis

email

string

Query

embedded
requis

embedded

string

Réponses
Code HTTP Description Schéma

200

OK

UserDto

Exemple de requête HTTP
Requête path
/iam/v1/cas/users
Requête query
{
  "email" : "string",
  "embedded" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "analytics" : {
    "applications" : [ {
      "accessCounter" : 0,
      "applicationId" : "string",
      "lastAccess" : "string"
    } ],
    "lastTenantIdentifier" : 0
  },
  "customerId" : "string",
  "disablingDate" : "string",
  "email" : "string",
  "firstname" : "string",
  "groupId" : "string",
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "language" : "string",
  "lastConnection" : "string",
  "lastname" : "string",
  "level" : "string",
  "mobile" : "string",
  "nbFailedAttempts" : 0,
  "otp" : true,
  "passwordExpirationDate" : "string",
  "phone" : "string",
  "readonly" : true,
  "removingDate" : "string",
  "siteCode" : "string",
  "status" : "string",
  "subrogeable" : true,
  "type" : "string"
}

2.3. Customers

Customers Management

2.3.1. create

POST /iam/v1/customers
Paramètres
Type Nom Schéma

Query

customerDto.address.city
optionnel

string

Query

customerDto.address.country
optionnel

string

Query

customerDto.address.street
optionnel

string

Query

customerDto.address.zipCode
optionnel

string

Query

customerDto.code
optionnel

string

Query

customerDto.companyName
optionnel

string

Query

customerDto.defaultEmailDomain
optionnel

string

Query

customerDto.emailDomains
optionnel

< string > array(multi)

Query

customerDto.enabled
optionnel

boolean

Query

customerDto.gdprAlert
optionnel

boolean

Query

customerDto.gdprAlertDelay
optionnel

integer (int32)

Query

customerDto.hasCustomGraphicIdentity
optionnel

boolean

Query

customerDto.id
optionnel

string

Query

customerDto.identifier
optionnel

string

Query

customerDto.internalCode
optionnel

string

Query

customerDto.language
optionnel

enum (ENGLISH, FRENCH, GERMANY)

Query

customerDto.name
optionnel

string

Query

customerDto.otp
optionnel

enum (DISABLED, MANDATORY, OPTIONAL)

Query

customerDto.owners[0].address.city
optionnel

string

Query

customerDto.owners[0].address.country
optionnel

string

Query

customerDto.owners[0].address.street
optionnel

string

Query

customerDto.owners[0].address.zipCode
optionnel

string

Query

customerDto.owners[0].code
optionnel

string

Query

customerDto.owners[0].companyName
optionnel

string

Query

customerDto.owners[0].customerId
optionnel

string

Query

customerDto.owners[0].id
optionnel

string

Query

customerDto.owners[0].identifier
optionnel

string

Query

customerDto.owners[0].internalCode
optionnel

string

Query

customerDto.owners[0].name
optionnel

string

Query

customerDto.owners[0].readonly
optionnel

boolean

Query

customerDto.passwordRevocationDelay
optionnel

integer (int32)

Query

customerDto.portalMessage
optionnel

string

Query

customerDto.portalTitle
optionnel

string

Query

customerDto.readonly
optionnel

boolean

Query

customerDto.subrogeable
optionnel

boolean

Query

footer
optionnel

file

Query

header
optionnel

file

Query

logo
optionnel

file

Query

portal
optionnel

file

Query

tenantName
optionnel

string

Réponses
Code HTTP Description Schéma

201

Created

CustomerDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/customers
Requête query
{
  "customerDto.address.city" : "string",
  "customerDto.address.country" : "string",
  "customerDto.address.street" : "string",
  "customerDto.address.zipCode" : "string",
  "customerDto.code" : "string",
  "customerDto.companyName" : "string",
  "customerDto.defaultEmailDomain" : "string",
  "customerDto.emailDomains" : "string",
  "customerDto.enabled" : true,
  "customerDto.gdprAlert" : true,
  "customerDto.gdprAlertDelay" : 0,
  "customerDto.hasCustomGraphicIdentity" : true,
  "customerDto.id" : "string",
  "customerDto.identifier" : "string",
  "customerDto.internalCode" : "string",
  "customerDto.language" : "string",
  "customerDto.name" : "string",
  "customerDto.otp" : "string",
  "customerDto.owners[0].address.city" : "string",
  "customerDto.owners[0].address.country" : "string",
  "customerDto.owners[0].address.street" : "string",
  "customerDto.owners[0].address.zipCode" : "string",
  "customerDto.owners[0].code" : "string",
  "customerDto.owners[0].companyName" : "string",
  "customerDto.owners[0].customerId" : "string",
  "customerDto.owners[0].id" : "string",
  "customerDto.owners[0].identifier" : "string",
  "customerDto.owners[0].internalCode" : "string",
  "customerDto.owners[0].name" : "string",
  "customerDto.owners[0].readonly" : true,
  "customerDto.passwordRevocationDelay" : 0,
  "customerDto.portalMessage" : "string",
  "customerDto.portalTitle" : "string",
  "customerDto.readonly" : true,
  "customerDto.subrogeable" : true,
  "footer" : "file",
  "header" : "file",
  "logo" : "file",
  "portal" : "file",
  "tenantName" : "string"
}
Exemple de réponse HTTP
Réponse 201
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "defaultEmailDomain" : "string",
  "emailDomains" : [ "string" ],
  "enabled" : true,
  "gdprAlert" : true,
  "gdprAlertDelay" : 0,
  "hasCustomGraphicIdentity" : true,
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "language" : "string",
  "name" : "string",
  "otp" : "string",
  "owners" : [ {
    "address" : {
      "city" : "string",
      "country" : "string",
      "street" : "string",
      "zipCode" : "string"
    },
    "code" : "string",
    "companyName" : "string",
    "customerId" : "string",
    "id" : "string",
    "identifier" : "string",
    "internalCode" : "string",
    "name" : "string",
    "readonly" : true
  } ],
  "passwordRevocationDelay" : 0,
  "portalMessage" : "string",
  "portalTitle" : "string",
  "readonly" : true,
  "subrogeable" : true,
  "themeColors" : {
    "string" : "string"
  }
}

2.3.2. getAllPaginated

GET /iam/v1/customers
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Query

direction
optionnel

direction

enum (ASC, DESC)

Query

orderBy
optionnel

orderBy

string

Query

page
requis

page

string

Query

size
requis

size

string

Réponses
Code HTTP Description Schéma

200

OK

PaginatedValuesDto«CustomerDto»

Exemple de requête HTTP
Requête path
/iam/v1/customers
Requête query
{
  "criteria" : "string",
  "direction" : "string",
  "orderBy" : "string",
  "page" : "string",
  "size" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "hasMore" : true,
  "pageNum" : 0,
  "pageSize" : 0,
  "values" : [ {
    "address" : {
      "city" : "string",
      "country" : "string",
      "street" : "string",
      "zipCode" : "string"
    },
    "code" : "string",
    "companyName" : "string",
    "defaultEmailDomain" : "string",
    "emailDomains" : [ "string" ],
    "enabled" : true,
    "gdprAlert" : true,
    "gdprAlertDelay" : 0,
    "hasCustomGraphicIdentity" : true,
    "id" : "string",
    "identifier" : "string",
    "internalCode" : "string",
    "language" : "string",
    "name" : "string",
    "otp" : "string",
    "owners" : [ {
      "address" : {
        "city" : "string",
        "country" : "string",
        "street" : "string",
        "zipCode" : "string"
      },
      "code" : "string",
      "companyName" : "string",
      "customerId" : "string",
      "id" : "string",
      "identifier" : "string",
      "internalCode" : "string",
      "name" : "string",
      "readonly" : true
    } ],
    "passwordRevocationDelay" : 0,
    "portalMessage" : "string",
    "portalTitle" : "string",
    "readonly" : true,
    "subrogeable" : true,
    "themeColors" : {
      "string" : "string"
    }
  } ]
}

2.3.3. checkExist

HEAD /iam/v1/customers/check
Paramètres
Type Nom Description Schéma

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/customers/check
Requête query
{
  "criteria" : "string"
}

2.3.4. getGdprSettingStatus

GET /iam/v1/customers/gdpr-status
Réponses
Code HTTP Description Schéma

200

OK

boolean

Exemple de requête HTTP
Requête path
/iam/v1/customers/gdpr-status

2.3.5. getMyCustomer

GET /iam/v1/customers/me
Réponses
Code HTTP Description Schéma

200

OK

CustomerDto

Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "defaultEmailDomain" : "string",
  "emailDomains" : [ "string" ],
  "enabled" : true,
  "gdprAlert" : true,
  "gdprAlertDelay" : 0,
  "hasCustomGraphicIdentity" : true,
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "language" : "string",
  "name" : "string",
  "otp" : "string",
  "owners" : [ {
    "address" : {
      "city" : "string",
      "country" : "string",
      "street" : "string",
      "zipCode" : "string"
    },
    "code" : "string",
    "companyName" : "string",
    "customerId" : "string",
    "id" : "string",
    "identifier" : "string",
    "internalCode" : "string",
    "name" : "string",
    "readonly" : true
  } ],
  "passwordRevocationDelay" : 0,
  "portalMessage" : "string",
  "portalTitle" : "string",
  "readonly" : true,
  "subrogeable" : true,
  "themeColors" : {
    "string" : "string"
  }
}

2.3.6. getOne

GET /iam/v1/customers/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

CustomerDto

Exemple de requête HTTP
Requête path
/iam/v1/customers/string
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "defaultEmailDomain" : "string",
  "emailDomains" : [ "string" ],
  "enabled" : true,
  "gdprAlert" : true,
  "gdprAlertDelay" : 0,
  "hasCustomGraphicIdentity" : true,
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "language" : "string",
  "name" : "string",
  "otp" : "string",
  "owners" : [ {
    "address" : {
      "city" : "string",
      "country" : "string",
      "street" : "string",
      "zipCode" : "string"
    },
    "code" : "string",
    "companyName" : "string",
    "customerId" : "string",
    "id" : "string",
    "identifier" : "string",
    "internalCode" : "string",
    "name" : "string",
    "readonly" : true
  } ],
  "passwordRevocationDelay" : 0,
  "portalMessage" : "string",
  "portalTitle" : "string",
  "readonly" : true,
  "subrogeable" : true,
  "themeColors" : {
    "string" : "string"
  }
}

2.3.7. update

PUT /iam/v1/customers/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

dto
requis

dto

CustomerDto

Réponses
Code HTTP Description Schéma

200

OK

CustomerDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/customers/string
Requête body
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "defaultEmailDomain" : "string",
  "emailDomains" : [ "string" ],
  "enabled" : true,
  "gdprAlert" : true,
  "gdprAlertDelay" : 0,
  "hasCustomGraphicIdentity" : true,
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "language" : "string",
  "name" : "string",
  "otp" : "string",
  "owners" : [ {
    "address" : {
      "city" : "string",
      "country" : "string",
      "street" : "string",
      "zipCode" : "string"
    },
    "code" : "string",
    "companyName" : "string",
    "customerId" : "string",
    "id" : "string",
    "identifier" : "string",
    "internalCode" : "string",
    "name" : "string",
    "readonly" : true
  } ],
  "passwordRevocationDelay" : 0,
  "portalMessage" : "string",
  "portalTitle" : "string",
  "readonly" : true,
  "subrogeable" : true,
  "themeColors" : {
    "string" : "string"
  }
}
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "defaultEmailDomain" : "string",
  "emailDomains" : [ "string" ],
  "enabled" : true,
  "gdprAlert" : true,
  "gdprAlertDelay" : 0,
  "hasCustomGraphicIdentity" : true,
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "language" : "string",
  "name" : "string",
  "otp" : "string",
  "owners" : [ {
    "address" : {
      "city" : "string",
      "country" : "string",
      "street" : "string",
      "zipCode" : "string"
    },
    "code" : "string",
    "companyName" : "string",
    "customerId" : "string",
    "id" : "string",
    "identifier" : "string",
    "internalCode" : "string",
    "name" : "string",
    "readonly" : true
  } ],
  "passwordRevocationDelay" : 0,
  "portalMessage" : "string",
  "portalTitle" : "string",
  "readonly" : true,
  "subrogeable" : true,
  "themeColors" : {
    "string" : "string"
  }
}

2.3.8. patch

PATCH /iam/v1/customers/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Query

footer
optionnel

file

Query

header
optionnel

file

Query

partialCustomerDto
optionnel

object

Query

portal
optionnel

file

Réponses
Code HTTP Description Schéma

200

OK

CustomerDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/customers/string
Requête query
{
  "footer" : "file",
  "header" : "file",
  "partialCustomerDto" : "object",
  "portal" : "file"
}
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "defaultEmailDomain" : "string",
  "emailDomains" : [ "string" ],
  "enabled" : true,
  "gdprAlert" : true,
  "gdprAlertDelay" : 0,
  "hasCustomGraphicIdentity" : true,
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "language" : "string",
  "name" : "string",
  "otp" : "string",
  "owners" : [ {
    "address" : {
      "city" : "string",
      "country" : "string",
      "street" : "string",
      "zipCode" : "string"
    },
    "code" : "string",
    "companyName" : "string",
    "customerId" : "string",
    "id" : "string",
    "identifier" : "string",
    "internalCode" : "string",
    "name" : "string",
    "readonly" : true
  } ],
  "passwordRevocationDelay" : 0,
  "portalMessage" : "string",
  "portalTitle" : "string",
  "readonly" : true,
  "subrogeable" : true,
  "themeColors" : {
    "string" : "string"
  }
}

2.3.9. findHistoryById

GET /iam/v1/customers/{id}/history
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Exemple de requête HTTP
Requête path
/iam/v1/customers/string/history

2.3.10. Get entity logo

GET /iam/v1/customers/{id}/logo
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Query

type
requis

type

enum (FOOTER, HEADER, PORTAL)

Réponses
Code HTTP Description Schéma

200

OK

Resource

Exemple de requête HTTP
Requête path
/iam/v1/customers/string/logo
Requête query
{
  "type" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "description" : "string",
  "file" : "file",
  "filename" : "string",
  "inputStream" : { },
  "open" : true,
  "readable" : true,
  "uri" : "string",
  "url" : "string"
}

2.4. ExternalParameters

External Parameters Internal Controller

2.4.1. getMyExternalParameters

GET /iam/v1/externalparameters/me
Réponses
Code HTTP Description Schéma

200

OK

ExternalParametersDto

Exemple de requête HTTP
Requête path
/iam/v1/externalparameters/me
Exemple de réponse HTTP
Réponse 200
{
  "id" : "string",
  "identifier" : "string",
  "name" : "string",
  "parameters" : [ {
    "key" : "string",
    "value" : "string"
  } ]
}

2.5. Groups

Profiles Groups Management

2.5.1. create

POST /iam/v1/groups
Paramètres
Type Nom Description Schéma

Body

dto
requis

dto

GroupDto

Réponses
Code HTTP Description Schéma

200

OK

GroupDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/groups
Requête body
{
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "profileIds" : [ "string" ],
  "profiles" : [ {
    "applicationName" : "string",
    "customerId" : "string",
    "description" : "string",
    "enabled" : true,
    "externalParamId" : "string",
    "externalParamIdentifier" : "string",
    "groupsCount" : 0,
    "id" : "string",
    "identifier" : "string",
    "level" : "string",
    "name" : "string",
    "readonly" : true,
    "roles" : [ {
      "name" : "string"
    } ],
    "tenantIdentifier" : 0,
    "tenantName" : "string",
    "usersCount" : 0
  } ],
  "readonly" : true,
  "usersCount" : 0
}
Exemple de réponse HTTP
Réponse 200
{
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "profileIds" : [ "string" ],
  "profiles" : [ {
    "applicationName" : "string",
    "customerId" : "string",
    "description" : "string",
    "enabled" : true,
    "externalParamId" : "string",
    "externalParamIdentifier" : "string",
    "groupsCount" : 0,
    "id" : "string",
    "identifier" : "string",
    "level" : "string",
    "name" : "string",
    "readonly" : true,
    "roles" : [ {
      "name" : "string"
    } ],
    "tenantIdentifier" : 0,
    "tenantName" : "string",
    "usersCount" : 0
  } ],
  "readonly" : true,
  "usersCount" : 0
}

2.5.2. getAll

GET /iam/v1/groups
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Query

embedded
requis

embedded

string

Réponses
Code HTTP Description Schéma

200

OK

< GroupDto > array

Exemple de requête HTTP
Requête path
/iam/v1/groups
Requête query
{
  "criteria" : "string",
  "embedded" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "profileIds" : [ "string" ],
  "profiles" : [ {
    "applicationName" : "string",
    "customerId" : "string",
    "description" : "string",
    "enabled" : true,
    "externalParamId" : "string",
    "externalParamIdentifier" : "string",
    "groupsCount" : 0,
    "id" : "string",
    "identifier" : "string",
    "level" : "string",
    "name" : "string",
    "readonly" : true,
    "roles" : [ {
      "name" : "string"
    } ],
    "tenantIdentifier" : 0,
    "tenantName" : "string",
    "usersCount" : 0
  } ],
  "readonly" : true,
  "usersCount" : 0
} ]

2.5.3. checkExist

HEAD /iam/v1/groups/check
Paramètres
Type Nom Description Schéma

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/groups/check
Requête query
{
  "criteria" : "string"
}

2.5.4. getLevels

GET /iam/v1/groups/levels
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< string > array

Exemple de requête HTTP
Requête path
/iam/v1/groups/levels
Requête query
{
  "criteria" : "string"
}

2.5.5. getOne

GET /iam/v1/groups/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Query

criteria
requis

criteria

string

Query

embedded
requis

embedded

string

Réponses
Code HTTP Description Schéma

200

OK

GroupDto

Exemple de requête HTTP
Requête path
/iam/v1/groups/string
Requête query
{
  "criteria" : "string",
  "embedded" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "profileIds" : [ "string" ],
  "profiles" : [ {
    "applicationName" : "string",
    "customerId" : "string",
    "description" : "string",
    "enabled" : true,
    "externalParamId" : "string",
    "externalParamIdentifier" : "string",
    "groupsCount" : 0,
    "id" : "string",
    "identifier" : "string",
    "level" : "string",
    "name" : "string",
    "readonly" : true,
    "roles" : [ {
      "name" : "string"
    } ],
    "tenantIdentifier" : 0,
    "tenantName" : "string",
    "usersCount" : 0
  } ],
  "readonly" : true,
  "usersCount" : 0
}

2.5.6. update

PUT /iam/v1/groups/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

dto
requis

dto

GroupDto

Réponses
Code HTTP Description Schéma

200

OK

GroupDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/groups/string
Requête body
{
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "profileIds" : [ "string" ],
  "profiles" : [ {
    "applicationName" : "string",
    "customerId" : "string",
    "description" : "string",
    "enabled" : true,
    "externalParamId" : "string",
    "externalParamIdentifier" : "string",
    "groupsCount" : 0,
    "id" : "string",
    "identifier" : "string",
    "level" : "string",
    "name" : "string",
    "readonly" : true,
    "roles" : [ {
      "name" : "string"
    } ],
    "tenantIdentifier" : 0,
    "tenantName" : "string",
    "usersCount" : 0
  } ],
  "readonly" : true,
  "usersCount" : 0
}
Exemple de réponse HTTP
Réponse 200
{
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "profileIds" : [ "string" ],
  "profiles" : [ {
    "applicationName" : "string",
    "customerId" : "string",
    "description" : "string",
    "enabled" : true,
    "externalParamId" : "string",
    "externalParamIdentifier" : "string",
    "groupsCount" : 0,
    "id" : "string",
    "identifier" : "string",
    "level" : "string",
    "name" : "string",
    "readonly" : true,
    "roles" : [ {
      "name" : "string"
    } ],
    "tenantIdentifier" : 0,
    "tenantName" : "string",
    "usersCount" : 0
  } ],
  "readonly" : true,
  "usersCount" : 0
}

2.5.7. patch

PATCH /iam/v1/groups/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

partialDto
requis

partialDto

object

Réponses
Code HTTP Description Schéma

200

OK

GroupDto

Consomme
  • application/json

Exemple de réponse HTTP
Réponse 200
{
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "profileIds" : [ "string" ],
  "profiles" : [ {
    "applicationName" : "string",
    "customerId" : "string",
    "description" : "string",
    "enabled" : true,
    "externalParamId" : "string",
    "externalParamIdentifier" : "string",
    "groupsCount" : 0,
    "id" : "string",
    "identifier" : "string",
    "level" : "string",
    "name" : "string",
    "readonly" : true,
    "roles" : [ {
      "name" : "string"
    } ],
    "tenantIdentifier" : 0,
    "tenantName" : "string",
    "usersCount" : 0
  } ],
  "readonly" : true,
  "usersCount" : 0
}

2.5.8. findHistoryById

GET /iam/v1/groups/{id}/history
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Exemple de requête HTTP
Requête path
/iam/v1/groups/string/history

2.6. Identityproviders

Identity Providers Management

2.6.1. create

POST /iam/v1/providers
Paramètres
Type Nom Description Schéma

Body

dto
requis

dto

IdentityProviderDto

Réponses
Code HTTP Description Schéma

200

OK

IdentityProviderDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/providers
Requête body
{
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "idpMetadata" : "string",
  "internal" : true,
  "keystoreBase64" : "string",
  "keystorePassword" : "string",
  "mailAttribute" : "string",
  "maximumAuthenticationLifetime" : 0,
  "name" : "string",
  "patterns" : [ "string" ],
  "privateKeyPassword" : "string",
  "readonly" : true,
  "spMetadata" : "string",
  "technicalName" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "idpMetadata" : "string",
  "internal" : true,
  "keystoreBase64" : "string",
  "keystorePassword" : "string",
  "mailAttribute" : "string",
  "maximumAuthenticationLifetime" : 0,
  "name" : "string",
  "patterns" : [ "string" ],
  "privateKeyPassword" : "string",
  "readonly" : true,
  "spMetadata" : "string",
  "technicalName" : "string"
}

2.6.2. getAll

GET /iam/v1/providers
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Query

embedded
requis

embedded

string

Réponses
Code HTTP Description Schéma

200

OK

< IdentityProviderDto > array

Exemple de requête HTTP
Requête path
/iam/v1/providers
Requête query
{
  "criteria" : "string",
  "embedded" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "idpMetadata" : "string",
  "internal" : true,
  "keystoreBase64" : "string",
  "keystorePassword" : "string",
  "mailAttribute" : "string",
  "maximumAuthenticationLifetime" : 0,
  "name" : "string",
  "patterns" : [ "string" ],
  "privateKeyPassword" : "string",
  "readonly" : true,
  "spMetadata" : "string",
  "technicalName" : "string"
} ]

2.6.3. checkExist

HEAD /iam/v1/providers/check
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/providers/check
Requête query
{
  "criteria" : "string"
}

2.6.4. getOne

GET /iam/v1/providers/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Query

criteria
requis

criteria

string

Query

embedded
requis

embedded

string

Réponses
Code HTTP Description Schéma

200

OK

IdentityProviderDto

Exemple de requête HTTP
Requête path
/iam/v1/providers/string
Requête query
{
  "criteria" : "string",
  "embedded" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "idpMetadata" : "string",
  "internal" : true,
  "keystoreBase64" : "string",
  "keystorePassword" : "string",
  "mailAttribute" : "string",
  "maximumAuthenticationLifetime" : 0,
  "name" : "string",
  "patterns" : [ "string" ],
  "privateKeyPassword" : "string",
  "readonly" : true,
  "spMetadata" : "string",
  "technicalName" : "string"
}

2.6.5. patch

PATCH /iam/v1/providers/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

partialDto
requis

partialDto

object

Réponses
Code HTTP Description Schéma

200

OK

IdentityProviderDto

Consomme
  • application/json

Exemple de réponse HTTP
Réponse 200
{
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "idpMetadata" : "string",
  "internal" : true,
  "keystoreBase64" : "string",
  "keystorePassword" : "string",
  "mailAttribute" : "string",
  "maximumAuthenticationLifetime" : 0,
  "name" : "string",
  "patterns" : [ "string" ],
  "privateKeyPassword" : "string",
  "readonly" : true,
  "spMetadata" : "string",
  "technicalName" : "string"
}

2.7. Logbooks

logbooks Management

2.7.1. Get object lifecycle by id

GET /v1/logbooks/objectslifecycles/{id}
Paramètres
Type Nom Description Schéma

Header

X-Access-Contract-Id
requis

X-Access-Contract-Id

string

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

LogbookLifeCycleResponseDto

Exemple de requête HTTP
Requête path
/v1/logbooks/objectslifecycles/string
Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "_id" : "string",
    "_tenant" : 0,
    "_v" : 0,
    "agId" : "string",
    "agIdApp" : "string",
    "agIdExt" : "string",
    "evDateTime" : "string",
    "evDetData" : "string",
    "evId" : "string",
    "evIdAppSession" : "string",
    "evIdReq" : "string",
    "evParentId" : "string",
    "evType" : "string",
    "evTypeProc" : "string",
    "events" : [ {
      "agId" : "string",
      "agIdApp" : "string",
      "agIdExt" : "string",
      "evDateTime" : "string",
      "evDetData" : "string",
      "evId" : "string",
      "evIdAppSession" : "string",
      "evIdReq" : "string",
      "evParentId" : "string",
      "evType" : "string",
      "evTypeProc" : "string",
      "id" : "string",
      "obId" : "string",
      "obIdReq" : "string",
      "outDetail" : "string",
      "outMessg" : "string",
      "outcome" : "string",
      "rightsStatementIdentifier" : "string"
    } ],
    "obId" : "string",
    "obIdReq" : "string",
    "outDetail" : "string",
    "outMessg" : "string",
    "outcome" : "string",
    "rightsStatementIdentifier" : "string"
  } ]
}

2.7.2. Get log book operation by json select

POST /v1/logbooks/operations
Paramètres
Type Nom Description Schéma

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Body

select
requis

select

JsonNode

Réponses
Code HTTP Description Schéma

200

OK

LogbookOperationsResponseDto

Consomme
  • application/json

Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "agId" : "string",
    "agIdApp" : "string",
    "agIdExt" : "string",
    "evDateTime" : "string",
    "evDetData" : "string",
    "evId" : "string",
    "evIdAppSession" : "string",
    "evIdReq" : "string",
    "evParentId" : "string",
    "evType" : "string",
    "evTypeProc" : "string",
    "events" : [ {
      "agId" : "string",
      "agIdApp" : "string",
      "agIdExt" : "string",
      "evDateTime" : "string",
      "evDetData" : "string",
      "evId" : "string",
      "evIdAppSession" : "string",
      "evIdReq" : "string",
      "evParentId" : "string",
      "evType" : "string",
      "evTypeProc" : "string",
      "id" : "string",
      "obId" : "string",
      "obIdReq" : "string",
      "outDetail" : "string",
      "outMessg" : "string",
      "outcome" : "string",
      "rightsStatementIdentifier" : "string"
    } ],
    "id" : "string",
    "obId" : "string",
    "obIdIn" : "string",
    "obIdReq" : "string",
    "outDetail" : "string",
    "outMessg" : "string",
    "outcome" : "string",
    "rightsStatementIdentifier" : "string"
  } ]
}

2.7.3. Get log book operation by id

GET /v1/logbooks/operations/{id}
Paramètres
Type Nom Description Schéma

Header

X-Access-Contract-Id
requis

X-Access-Contract-Id

string

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

LogbookOperationsResponseDto

Exemple de requête HTTP
Requête path
/v1/logbooks/operations/string
Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "agId" : "string",
    "agIdApp" : "string",
    "agIdExt" : "string",
    "evDateTime" : "string",
    "evDetData" : "string",
    "evId" : "string",
    "evIdAppSession" : "string",
    "evIdReq" : "string",
    "evParentId" : "string",
    "evType" : "string",
    "evTypeProc" : "string",
    "events" : [ {
      "agId" : "string",
      "agIdApp" : "string",
      "agIdExt" : "string",
      "evDateTime" : "string",
      "evDetData" : "string",
      "evId" : "string",
      "evIdAppSession" : "string",
      "evIdReq" : "string",
      "evParentId" : "string",
      "evType" : "string",
      "evTypeProc" : "string",
      "id" : "string",
      "obId" : "string",
      "obIdReq" : "string",
      "outDetail" : "string",
      "outMessg" : "string",
      "outcome" : "string",
      "rightsStatementIdentifier" : "string"
    } ],
    "id" : "string",
    "obId" : "string",
    "obIdIn" : "string",
    "obIdReq" : "string",
    "outDetail" : "string",
    "outMessg" : "string",
    "outcome" : "string",
    "rightsStatementIdentifier" : "string"
  } ]
}

2.7.4. Download the ATR for a given operation

GET /v1/logbooks/operations/{id}/download/atr
Paramètres
Type Nom Description Schéma

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Exemple de requête HTTP
Requête path
/v1/logbooks/operations/string/download/atr

2.7.5. Download the manifest for a given operation

GET /v1/logbooks/operations/{id}/download/manifest
Paramètres
Type Nom Description Schéma

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Exemple de requête HTTP
Requête path
/v1/logbooks/operations/string/download/manifest

2.7.6. Download the report file for a given operation

GET /v1/logbooks/operations/{id}/download/{downloadType}
Paramètres
Type Nom Description Schéma

Header

X-Access-Contract-Id
requis

X-Access-Contract-Id

string

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Path

downloadType
requis

downloadType

string

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Exemple de requête HTTP
Requête path
/v1/logbooks/operations/string/download/string

2.7.7. Get unit lifecycle by id

GET /v1/logbooks/unitlifecycles/{id}
Paramètres
Type Nom Description Schéma

Header

X-Access-Contract-Id
requis

X-Access-Contract-Id

string

Header

X-Tenant-Id
requis

X-Tenant-Id

integer (int32)

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

LogbookLifeCycleResponseDto

Exemple de requête HTTP
Requête path
/v1/logbooks/unitlifecycles/string
Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "_id" : "string",
    "_tenant" : 0,
    "_v" : 0,
    "agId" : "string",
    "agIdApp" : "string",
    "agIdExt" : "string",
    "evDateTime" : "string",
    "evDetData" : "string",
    "evId" : "string",
    "evIdAppSession" : "string",
    "evIdReq" : "string",
    "evParentId" : "string",
    "evType" : "string",
    "evTypeProc" : "string",
    "events" : [ {
      "agId" : "string",
      "agIdApp" : "string",
      "agIdExt" : "string",
      "evDateTime" : "string",
      "evDetData" : "string",
      "evId" : "string",
      "evIdAppSession" : "string",
      "evIdReq" : "string",
      "evParentId" : "string",
      "evType" : "string",
      "evTypeProc" : "string",
      "id" : "string",
      "obId" : "string",
      "obIdReq" : "string",
      "outDetail" : "string",
      "outMessg" : "string",
      "outcome" : "string",
      "rightsStatementIdentifier" : "string"
    } ],
    "obId" : "string",
    "obIdReq" : "string",
    "outDetail" : "string",
    "outMessg" : "string",
    "outcome" : "string",
    "rightsStatementIdentifier" : "string"
  } ]
}

2.8. Owners

Owners Management

2.8.1. create

POST /iam/v1/owners
Paramètres
Type Nom Description Schéma

Body

dto
requis

dto

OwnerDto

Réponses
Code HTTP Description Schéma

200

OK

OwnerDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/owners
Requête body
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "customerId" : "string",
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "name" : "string",
  "readonly" : true
}
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "customerId" : "string",
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "name" : "string",
  "readonly" : true
}

2.8.2. checkExist

HEAD /iam/v1/owners/check
Paramètres
Type Nom Description Schéma

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/owners/check
Requête query
{
  "criteria" : "string"
}

2.8.3. getOne

GET /iam/v1/owners/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

OwnerDto

Exemple de requête HTTP
Requête path
/iam/v1/owners/string
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "customerId" : "string",
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "name" : "string",
  "readonly" : true
}

2.8.4. update

PUT /iam/v1/owners/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

dto
requis

dto

OwnerDto

Réponses
Code HTTP Description Schéma

200

OK

OwnerDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/owners/string
Requête body
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "customerId" : "string",
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "name" : "string",
  "readonly" : true
}
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "customerId" : "string",
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "name" : "string",
  "readonly" : true
}

2.8.5. patch

PATCH /iam/v1/owners/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

partialDto
requis

partialDto

object

Réponses
Code HTTP Description Schéma

200

OK

OwnerDto

Consomme
  • application/json

Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "customerId" : "string",
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "name" : "string",
  "readonly" : true
}

2.8.6. findHistoryById

GET /iam/v1/owners/{id}/history
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Exemple de requête HTTP
Requête path
/iam/v1/owners/string/history

2.9. Profiles

Profiles Management

2.9.1. create

POST /iam/v1/profiles
Paramètres
Type Nom Description Schéma

Body

dto
requis

dto

ProfileDto

Réponses
Code HTTP Description Schéma

200

OK

ProfileDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/profiles
Requête body
{
  "applicationName" : "string",
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "externalParamId" : "string",
  "externalParamIdentifier" : "string",
  "groupsCount" : 0,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "readonly" : true,
  "roles" : [ {
    "name" : "string"
  } ],
  "tenantIdentifier" : 0,
  "tenantName" : "string",
  "usersCount" : 0
}
Exemple de réponse HTTP
Réponse 200
{
  "applicationName" : "string",
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "externalParamId" : "string",
  "externalParamIdentifier" : "string",
  "groupsCount" : 0,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "readonly" : true,
  "roles" : [ {
    "name" : "string"
  } ],
  "tenantIdentifier" : 0,
  "tenantName" : "string",
  "usersCount" : 0
}

2.9.2. getAll

GET /iam/v1/profiles
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Query

embedded
requis

embedded

string

Réponses
Code HTTP Description Schéma

200

OK

< ProfileDto > array

Exemple de requête HTTP
Requête path
/iam/v1/profiles
Requête query
{
  "criteria" : "string",
  "embedded" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "applicationName" : "string",
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "externalParamId" : "string",
  "externalParamIdentifier" : "string",
  "groupsCount" : 0,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "readonly" : true,
  "roles" : [ {
    "name" : "string"
  } ],
  "tenantIdentifier" : 0,
  "tenantName" : "string",
  "usersCount" : 0
} ]

2.9.3. checkExist

HEAD /iam/v1/profiles/check
Paramètres
Type Nom Description Schéma

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/profiles/check
Requête query
{
  "criteria" : "string"
}

2.9.4. getLevels

GET /iam/v1/profiles/levels
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< string > array

Exemple de requête HTTP
Requête path
/iam/v1/profiles/levels
Requête query
{
  "criteria" : "string"
}

2.9.5. getOne

GET /iam/v1/profiles/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Query

criteria
requis

criteria

string

Query

embedded
requis

embedded

string

Réponses
Code HTTP Description Schéma

200

OK

ProfileDto

Exemple de requête HTTP
Requête path
/iam/v1/profiles/string
Requête query
{
  "criteria" : "string",
  "embedded" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "applicationName" : "string",
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "externalParamId" : "string",
  "externalParamIdentifier" : "string",
  "groupsCount" : 0,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "readonly" : true,
  "roles" : [ {
    "name" : "string"
  } ],
  "tenantIdentifier" : 0,
  "tenantName" : "string",
  "usersCount" : 0
}

2.9.6. patch

PATCH /iam/v1/profiles/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

partialDto
requis

partialDto

object

Réponses
Code HTTP Description Schéma

200

OK

ProfileDto

Consomme
  • application/json

Exemple de réponse HTTP
Réponse 200
{
  "applicationName" : "string",
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "externalParamId" : "string",
  "externalParamIdentifier" : "string",
  "groupsCount" : 0,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "readonly" : true,
  "roles" : [ {
    "name" : "string"
  } ],
  "tenantIdentifier" : 0,
  "tenantName" : "string",
  "usersCount" : 0
}

2.9.7. findHistoryById

GET /iam/v1/profiles/{id}/history
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Exemple de requête HTTP
Requête path
/iam/v1/profiles/string/history

2.10. Status

Status check and autotest

2.10.1. autotest

GET /autotest
Réponses
Code HTTP Description Schéma

200

OK

string

2.10.2. status

GET /status
Réponses
Code HTTP Description Schéma

200

OK

string

2.11. Subrogations

Subrogation Management

2.11.1. create

POST /iam/v1/subrogations
Paramètres
Type Nom Description Schéma

Body

dto
requis

dto

SubrogationDto

Réponses
Code HTTP Description Schéma

200

OK

SubrogationDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/subrogations
Requête body
{
  "date" : "string",
  "id" : "string",
  "status" : "string",
  "superUser" : "string",
  "superUserCustomerId" : "string",
  "surrogate" : "string",
  "surrogateCustomerId" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "date" : "string",
  "id" : "string",
  "status" : "string",
  "superUser" : "string",
  "superUserCustomerId" : "string",
  "surrogate" : "string",
  "surrogateCustomerId" : "string"
}

2.11.2. getAll

GET /iam/v1/subrogations
Paramètres
Type Nom Description Schéma

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< SubrogationDto > array

Exemple de requête HTTP
Requête path
/iam/v1/subrogations
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "date" : "string",
  "id" : "string",
  "status" : "string",
  "superUser" : "string",
  "superUserCustomerId" : "string",
  "surrogate" : "string",
  "surrogateCustomerId" : "string"
} ]

2.11.3. getGroupById

GET /iam/v1/subrogations/groups/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Query

embedded
requis

embedded

string

Réponses
Code HTTP Description Schéma

200

OK

GroupDto

Exemple de requête HTTP
Requête path
/iam/v1/subrogations/groups/string
Requête query
{
  "embedded" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "profileIds" : [ "string" ],
  "profiles" : [ {
    "applicationName" : "string",
    "customerId" : "string",
    "description" : "string",
    "enabled" : true,
    "externalParamId" : "string",
    "externalParamIdentifier" : "string",
    "groupsCount" : 0,
    "id" : "string",
    "identifier" : "string",
    "level" : "string",
    "name" : "string",
    "readonly" : true,
    "roles" : [ {
      "name" : "string"
    } ],
    "tenantIdentifier" : 0,
    "tenantName" : "string",
    "usersCount" : 0
  } ],
  "readonly" : true,
  "usersCount" : 0
}

2.11.4. getMySubrogationAsSuperuser

GET /iam/v1/subrogations/me/superuser
Réponses
Code HTTP Description Schéma

200

OK

SubrogationDto

Exemple de requête HTTP
Requête path
/iam/v1/subrogations/me/superuser
Exemple de réponse HTTP
Réponse 200
{
  "date" : "string",
  "id" : "string",
  "status" : "string",
  "superUser" : "string",
  "superUserCustomerId" : "string",
  "surrogate" : "string",
  "surrogateCustomerId" : "string"
}

2.11.5. getMySubrogationAsSurrogate

GET /iam/v1/subrogations/me/surrogate
Réponses
Code HTTP Description Schéma

200

OK

SubrogationDto

Exemple de requête HTTP
Requête path
/iam/v1/subrogations/me/surrogate
Exemple de réponse HTTP
Réponse 200
{
  "date" : "string",
  "id" : "string",
  "status" : "string",
  "superUser" : "string",
  "superUserCustomerId" : "string",
  "surrogate" : "string",
  "surrogateCustomerId" : "string"
}

2.11.6. accept

PATCH /iam/v1/subrogations/surrogate/accept/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

SubrogationDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/subrogations/surrogate/accept/string
Exemple de réponse HTTP
Réponse 200
{
  "date" : "string",
  "id" : "string",
  "status" : "string",
  "superUser" : "string",
  "superUserCustomerId" : "string",
  "surrogate" : "string",
  "surrogateCustomerId" : "string"
}

2.11.7. decline

DELETE /iam/v1/subrogations/surrogate/decline/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Exemple de requête HTTP
Requête path
/iam/v1/subrogations/surrogate/decline/string

2.11.8. getUsers

GET /iam/v1/subrogations/users
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Query

direction
optionnel

direction

enum (ASC, DESC)

Query

orderBy
optionnel

orderBy

string

Query

page
requis

page

string

Query

size
requis

size

string

Réponses
Code HTTP Description Schéma

200

OK

PaginatedValuesDto«UserDto»

Exemple de requête HTTP
Requête path
/iam/v1/subrogations/users
Requête query
{
  "criteria" : "string",
  "direction" : "string",
  "orderBy" : "string",
  "page" : "string",
  "size" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "hasMore" : true,
  "pageNum" : 0,
  "pageSize" : 0,
  "values" : [ {
    "address" : {
      "city" : "string",
      "country" : "string",
      "street" : "string",
      "zipCode" : "string"
    },
    "analytics" : {
      "applications" : [ {
        "accessCounter" : 0,
        "applicationId" : "string",
        "lastAccess" : "string"
      } ],
      "lastTenantIdentifier" : 0
    },
    "customerId" : "string",
    "disablingDate" : "string",
    "email" : "string",
    "firstname" : "string",
    "groupId" : "string",
    "id" : "string",
    "identifier" : "string",
    "internalCode" : "string",
    "language" : "string",
    "lastConnection" : "string",
    "lastname" : "string",
    "level" : "string",
    "mobile" : "string",
    "nbFailedAttempts" : 0,
    "otp" : true,
    "passwordExpirationDate" : "string",
    "phone" : "string",
    "readonly" : true,
    "removingDate" : "string",
    "siteCode" : "string",
    "status" : "string",
    "subrogeable" : true,
    "type" : "string"
  } ]
}

2.11.9. getOne

GET /iam/v1/subrogations/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

SubrogationDto

Exemple de requête HTTP
Requête path
/iam/v1/subrogations/string
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "date" : "string",
  "id" : "string",
  "status" : "string",
  "superUser" : "string",
  "superUserCustomerId" : "string",
  "surrogate" : "string",
  "surrogateCustomerId" : "string"
}

2.11.10. update

PUT /iam/v1/subrogations/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

dto
requis

dto

SubrogationDto

Réponses
Code HTTP Description Schéma

200

OK

SubrogationDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/subrogations/string
Requête body
{
  "date" : "string",
  "id" : "string",
  "status" : "string",
  "superUser" : "string",
  "superUserCustomerId" : "string",
  "surrogate" : "string",
  "surrogateCustomerId" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "date" : "string",
  "id" : "string",
  "status" : "string",
  "superUser" : "string",
  "superUserCustomerId" : "string",
  "surrogate" : "string",
  "surrogateCustomerId" : "string"
}

2.11.11. delete

DELETE /iam/v1/subrogations/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Exemple de requête HTTP
Requête path
/iam/v1/subrogations/string

2.11.12. checkExist

HEAD /iam/v1/subrogations/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/subrogations/string

2.12. Tenants

Tenants Management

2.12.1. create

POST /iam/v1/tenants
Paramètres
Type Nom Description Schéma

Body

dto
requis

dto

TenantDto

Réponses
Code HTTP Description Schéma

200

OK

TenantDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/tenants
Requête body
{
  "accessContractHoldingIdentifier" : "string",
  "accessContractLogbookIdentifier" : "string",
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : 0,
  "ingestContractHoldingIdentifier" : "string",
  "itemIngestContractIdentifier" : "string",
  "name" : "string",
  "ownerId" : "string",
  "proof" : true,
  "readonly" : true
}
Exemple de réponse HTTP
Réponse 200
{
  "accessContractHoldingIdentifier" : "string",
  "accessContractLogbookIdentifier" : "string",
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : 0,
  "ingestContractHoldingIdentifier" : "string",
  "itemIngestContractIdentifier" : "string",
  "name" : "string",
  "ownerId" : "string",
  "proof" : true,
  "readonly" : true
}

2.12.2. getAll

GET /iam/v1/tenants
Paramètres
Type Nom Description Schéma

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< TenantDto > array

Exemple de requête HTTP
Requête path
/iam/v1/tenants
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "accessContractHoldingIdentifier" : "string",
  "accessContractLogbookIdentifier" : "string",
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : 0,
  "ingestContractHoldingIdentifier" : "string",
  "itemIngestContractIdentifier" : "string",
  "name" : "string",
  "ownerId" : "string",
  "proof" : true,
  "readonly" : true
} ]

2.12.3. checkExist

HEAD /iam/v1/tenants/check
Paramètres
Type Nom Description Schéma

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/tenants/check
Requête query
{
  "criteria" : "string"
}

2.12.4. getOne

GET /iam/v1/tenants/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

TenantDto

Exemple de requête HTTP
Requête path
/iam/v1/tenants/string
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "accessContractHoldingIdentifier" : "string",
  "accessContractLogbookIdentifier" : "string",
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : 0,
  "ingestContractHoldingIdentifier" : "string",
  "itemIngestContractIdentifier" : "string",
  "name" : "string",
  "ownerId" : "string",
  "proof" : true,
  "readonly" : true
}

2.12.5. update

PUT /iam/v1/tenants/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

dto
requis

dto

TenantDto

Réponses
Code HTTP Description Schéma

200

OK

TenantDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/tenants/string
Requête body
{
  "accessContractHoldingIdentifier" : "string",
  "accessContractLogbookIdentifier" : "string",
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : 0,
  "ingestContractHoldingIdentifier" : "string",
  "itemIngestContractIdentifier" : "string",
  "name" : "string",
  "ownerId" : "string",
  "proof" : true,
  "readonly" : true
}
Exemple de réponse HTTP
Réponse 200
{
  "accessContractHoldingIdentifier" : "string",
  "accessContractLogbookIdentifier" : "string",
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : 0,
  "ingestContractHoldingIdentifier" : "string",
  "itemIngestContractIdentifier" : "string",
  "name" : "string",
  "ownerId" : "string",
  "proof" : true,
  "readonly" : true
}

2.12.6. patch

PATCH /iam/v1/tenants/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

partialDto
requis

partialDto

object

Réponses
Code HTTP Description Schéma

200

OK

TenantDto

Consomme
  • application/json

Exemple de réponse HTTP
Réponse 200
{
  "accessContractHoldingIdentifier" : "string",
  "accessContractLogbookIdentifier" : "string",
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : 0,
  "ingestContractHoldingIdentifier" : "string",
  "itemIngestContractIdentifier" : "string",
  "name" : "string",
  "ownerId" : "string",
  "proof" : true,
  "readonly" : true
}

2.12.7. findHistoryById

GET /iam/v1/tenants/{id}/history
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Exemple de requête HTTP
Requête path
/iam/v1/tenants/string/history

2.13. Users

Users Management

2.13.1. create

POST /iam/v1/users
Paramètres
Type Nom Description Schéma

Body

dto
requis

dto

UserDto

Réponses
Code HTTP Description Schéma

200

OK

UserDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/users
Requête body
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "analytics" : {
    "applications" : [ {
      "accessCounter" : 0,
      "applicationId" : "string",
      "lastAccess" : "string"
    } ],
    "lastTenantIdentifier" : 0
  },
  "customerId" : "string",
  "disablingDate" : "string",
  "email" : "string",
  "firstname" : "string",
  "groupId" : "string",
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "language" : "string",
  "lastConnection" : "string",
  "lastname" : "string",
  "level" : "string",
  "mobile" : "string",
  "nbFailedAttempts" : 0,
  "otp" : true,
  "passwordExpirationDate" : "string",
  "phone" : "string",
  "readonly" : true,
  "removingDate" : "string",
  "siteCode" : "string",
  "status" : "string",
  "subrogeable" : true,
  "type" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "analytics" : {
    "applications" : [ {
      "accessCounter" : 0,
      "applicationId" : "string",
      "lastAccess" : "string"
    } ],
    "lastTenantIdentifier" : 0
  },
  "customerId" : "string",
  "disablingDate" : "string",
  "email" : "string",
  "firstname" : "string",
  "groupId" : "string",
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "language" : "string",
  "lastConnection" : "string",
  "lastname" : "string",
  "level" : "string",
  "mobile" : "string",
  "nbFailedAttempts" : 0,
  "otp" : true,
  "passwordExpirationDate" : "string",
  "phone" : "string",
  "readonly" : true,
  "removingDate" : "string",
  "siteCode" : "string",
  "status" : "string",
  "subrogeable" : true,
  "type" : "string"
}

2.13.2. getAllPaginated

GET /iam/v1/users
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Query

direction
optionnel

direction

enum (ASC, DESC)

Query

orderBy
optionnel

orderBy

string

Query

page
requis

page

string

Query

size
requis

size

string

Réponses
Code HTTP Description Schéma

200

OK

PaginatedValuesDto«UserDto»

Exemple de requête HTTP
Requête path
/iam/v1/users
Requête query
{
  "criteria" : "string",
  "direction" : "string",
  "orderBy" : "string",
  "page" : "string",
  "size" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "hasMore" : true,
  "pageNum" : 0,
  "pageSize" : 0,
  "values" : [ {
    "address" : {
      "city" : "string",
      "country" : "string",
      "street" : "string",
      "zipCode" : "string"
    },
    "analytics" : {
      "applications" : [ {
        "accessCounter" : 0,
        "applicationId" : "string",
        "lastAccess" : "string"
      } ],
      "lastTenantIdentifier" : 0
    },
    "customerId" : "string",
    "disablingDate" : "string",
    "email" : "string",
    "firstname" : "string",
    "groupId" : "string",
    "id" : "string",
    "identifier" : "string",
    "internalCode" : "string",
    "language" : "string",
    "lastConnection" : "string",
    "lastname" : "string",
    "level" : "string",
    "mobile" : "string",
    "nbFailedAttempts" : 0,
    "otp" : true,
    "passwordExpirationDate" : "string",
    "phone" : "string",
    "readonly" : true,
    "removingDate" : "string",
    "siteCode" : "string",
    "status" : "string",
    "subrogeable" : true,
    "type" : "string"
  } ]
}

2.13.3. patchAnalytics

POST /iam/v1/users/analytics
Paramètres
Type Nom Description Schéma

Body

partialDto
requis

partialDto

object

Réponses
Code HTTP Description Schéma

200

OK

UserDto

Consomme
  • application/json

Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "analytics" : {
    "applications" : [ {
      "accessCounter" : 0,
      "applicationId" : "string",
      "lastAccess" : "string"
    } ],
    "lastTenantIdentifier" : 0
  },
  "customerId" : "string",
  "disablingDate" : "string",
  "email" : "string",
  "firstname" : "string",
  "groupId" : "string",
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "language" : "string",
  "lastConnection" : "string",
  "lastname" : "string",
  "level" : "string",
  "mobile" : "string",
  "nbFailedAttempts" : 0,
  "otp" : true,
  "passwordExpirationDate" : "string",
  "phone" : "string",
  "readonly" : true,
  "removingDate" : "string",
  "siteCode" : "string",
  "status" : "string",
  "subrogeable" : true,
  "type" : "string"
}

2.13.4. checkExist

HEAD /iam/v1/users/check
Paramètres
Type Nom Description Schéma

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/users/check
Requête query
{
  "criteria" : "string"
}

2.13.5. getLevels

GET /iam/v1/users/levels
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< string > array

Exemple de requête HTTP
Requête path
/iam/v1/users/levels
Requête query
{
  "criteria" : "string"
}

2.13.6. getMe

GET /iam/v1/users/me
Réponses
Code HTTP Description Schéma

200

OK

AuthUserDto

Exemple de réponse HTTP
Réponse 200
{
  "accountNonExpired" : true,
  "accountNonLocked" : true,
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "analytics" : {
    "applications" : [ {
      "accessCounter" : 0,
      "applicationId" : "string",
      "lastAccess" : "string"
    } ],
    "lastTenantIdentifier" : 0
  },
  "authToken" : "string",
  "authorities" : [ {
    "authority" : "string"
  } ],
  "basicCustomer" : {
    "companyName" : "string",
    "graphicIdentity" : {
      "footerDataBase64" : "string",
      "hasCustomGraphicIdentity" : true,
      "headerDataBase64" : "string",
      "portalDataBase64" : "string",
      "portalMessage" : "string",
      "portalTitle" : "string",
      "themeColors" : {
        "string" : "string"
      }
    },
    "id" : "string",
    "identifier" : "string",
    "name" : "string"
  },
  "credentialsNonExpired" : true,
  "customerId" : "string",
  "customerIdentifier" : "string",
  "disablingDate" : "string",
  "email" : "string",
  "enabled" : true,
  "firstname" : "string",
  "groupId" : "string",
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "language" : "string",
  "lastConnection" : "string",
  "lastname" : "string",
  "level" : "string",
  "mobile" : "string",
  "nbFailedAttempts" : 0,
  "otp" : true,
  "password" : "string",
  "passwordExpirationDate" : "string",
  "phone" : "string",
  "profileGroup" : {
    "customerId" : "string",
    "description" : "string",
    "enabled" : true,
    "id" : "string",
    "identifier" : "string",
    "level" : "string",
    "name" : "string",
    "profileIds" : [ "string" ],
    "profiles" : [ {
      "applicationName" : "string",
      "customerId" : "string",
      "description" : "string",
      "enabled" : true,
      "externalParamId" : "string",
      "externalParamIdentifier" : "string",
      "groupsCount" : 0,
      "id" : "string",
      "identifier" : "string",
      "level" : "string",
      "name" : "string",
      "readonly" : true,
      "roles" : [ {
        "name" : "string"
      } ],
      "tenantIdentifier" : 0,
      "tenantName" : "string",
      "usersCount" : 0
    } ],
    "readonly" : true,
    "usersCount" : 0
  },
  "proofTenantIdentifier" : 0,
  "readonly" : true,
  "removingDate" : "string",
  "siteCode" : "string",
  "status" : "string",
  "subrogeable" : true,
  "superUser" : "string",
  "superUserIdentifier" : "string",
  "tenantsByApp" : [ {
    "name" : "string",
    "tenants" : [ {
      "accessContractHoldingIdentifier" : "string",
      "accessContractLogbookIdentifier" : "string",
      "customerId" : "string",
      "enabled" : true,
      "id" : "string",
      "identifier" : 0,
      "ingestContractHoldingIdentifier" : "string",
      "itemIngestContractIdentifier" : "string",
      "name" : "string",
      "ownerId" : "string",
      "proof" : true,
      "readonly" : true
    } ]
  } ],
  "type" : "string",
  "username" : "string"
}

2.13.7. getOne

GET /iam/v1/users/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

UserDto

Exemple de requête HTTP
Requête path
/iam/v1/users/string
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "analytics" : {
    "applications" : [ {
      "accessCounter" : 0,
      "applicationId" : "string",
      "lastAccess" : "string"
    } ],
    "lastTenantIdentifier" : 0
  },
  "customerId" : "string",
  "disablingDate" : "string",
  "email" : "string",
  "firstname" : "string",
  "groupId" : "string",
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "language" : "string",
  "lastConnection" : "string",
  "lastname" : "string",
  "level" : "string",
  "mobile" : "string",
  "nbFailedAttempts" : 0,
  "otp" : true,
  "passwordExpirationDate" : "string",
  "phone" : "string",
  "readonly" : true,
  "removingDate" : "string",
  "siteCode" : "string",
  "status" : "string",
  "subrogeable" : true,
  "type" : "string"
}

2.13.8. update

PUT /iam/v1/users/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

dto
requis

dto

UserDto

Réponses
Code HTTP Description Schéma

200

OK

UserDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/iam/v1/users/string
Requête body
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "analytics" : {
    "applications" : [ {
      "accessCounter" : 0,
      "applicationId" : "string",
      "lastAccess" : "string"
    } ],
    "lastTenantIdentifier" : 0
  },
  "customerId" : "string",
  "disablingDate" : "string",
  "email" : "string",
  "firstname" : "string",
  "groupId" : "string",
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "language" : "string",
  "lastConnection" : "string",
  "lastname" : "string",
  "level" : "string",
  "mobile" : "string",
  "nbFailedAttempts" : 0,
  "otp" : true,
  "passwordExpirationDate" : "string",
  "phone" : "string",
  "readonly" : true,
  "removingDate" : "string",
  "siteCode" : "string",
  "status" : "string",
  "subrogeable" : true,
  "type" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "analytics" : {
    "applications" : [ {
      "accessCounter" : 0,
      "applicationId" : "string",
      "lastAccess" : "string"
    } ],
    "lastTenantIdentifier" : 0
  },
  "customerId" : "string",
  "disablingDate" : "string",
  "email" : "string",
  "firstname" : "string",
  "groupId" : "string",
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "language" : "string",
  "lastConnection" : "string",
  "lastname" : "string",
  "level" : "string",
  "mobile" : "string",
  "nbFailedAttempts" : 0,
  "otp" : true,
  "passwordExpirationDate" : "string",
  "phone" : "string",
  "readonly" : true,
  "removingDate" : "string",
  "siteCode" : "string",
  "status" : "string",
  "subrogeable" : true,
  "type" : "string"
}

2.13.9. patch

PATCH /iam/v1/users/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

partialDto
requis

partialDto

object

Réponses
Code HTTP Description Schéma

200

OK

UserDto

Consomme
  • application/json

Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "analytics" : {
    "applications" : [ {
      "accessCounter" : 0,
      "applicationId" : "string",
      "lastAccess" : "string"
    } ],
    "lastTenantIdentifier" : 0
  },
  "customerId" : "string",
  "disablingDate" : "string",
  "email" : "string",
  "firstname" : "string",
  "groupId" : "string",
  "id" : "string",
  "identifier" : "string",
  "internalCode" : "string",
  "language" : "string",
  "lastConnection" : "string",
  "lastname" : "string",
  "level" : "string",
  "mobile" : "string",
  "nbFailedAttempts" : 0,
  "otp" : true,
  "passwordExpirationDate" : "string",
  "phone" : "string",
  "readonly" : true,
  "removingDate" : "string",
  "siteCode" : "string",
  "status" : "string",
  "subrogeable" : true,
  "type" : "string"
}

2.13.10. findHistoryById

GET /iam/v1/users/{id}/history
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

JsonNode

Exemple de requête HTTP
Requête path
/iam/v1/users/string/history

3. Définitions

3.1. AddressDto

Nom Description Schéma

city
optionnel

Exemple : "string"

string

country
optionnel

Exemple : "string"

string

street
optionnel

Exemple : "string"

string

zipCode
optionnel

Exemple : "string"

string

3.2. AnalyticsDto

Nom Description Schéma

applications
optionnel

Exemple : [ "ApplicationAnalyticsDto" ]

< ApplicationAnalyticsDto > array

lastTenantIdentifier
optionnel

Exemple : 0

integer (int32)

3.3. ApplicationAnalyticsDto

Nom Description Schéma

accessCounter
optionnel

Exemple : 0

integer (int32)

applicationId
optionnel

Exemple : "string"

string

lastAccess
optionnel

Exemple : "string"

string (date-time)

3.4. ApplicationDto

Nom Description Schéma

category
optionnel

Exemple : "string"

string

hasCustomerList
optionnel

Exemple : true

boolean

hasHighlight
optionnel

Exemple : true

boolean

hasTenantList
optionnel

Exemple : true

boolean

icon
optionnel

Exemple : "string"

string

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

position
optionnel

Exemple : 0

integer (int32)

target
optionnel

Exemple : "string"

string

tooltip
optionnel

Exemple : "string"

string

url
optionnel

Exemple : "string"

string

3.5. AuthUserDto

Nom Description Schéma

accountNonExpired
optionnel

Exemple : true

boolean

accountNonLocked
optionnel

Exemple : true

boolean

address
optionnel

Exemple : "AddressDto"

AddressDto

analytics
optionnel

Exemple : "AnalyticsDto"

AnalyticsDto

authToken
optionnel

Exemple : "string"

string

authorities
optionnel

Exemple : [ "GrantedAuthority" ]

< GrantedAuthority > array

basicCustomer
optionnel

Exemple : "BasicCustomerDto"

BasicCustomerDto

credentialsNonExpired
optionnel

Exemple : true

boolean

customerId
optionnel

Exemple : "string"

string

customerIdentifier
optionnel

Exemple : "string"

string

disablingDate
optionnel

Exemple : "string"

string (date-time)

email
optionnel

Exemple : "string"

string

enabled
optionnel

Exemple : true

boolean

firstname
optionnel

Exemple : "string"

string

groupId
optionnel

Exemple : "string"

string

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

internalCode
optionnel

Exemple : "string"

string

language
optionnel

Exemple : "string"

string

lastConnection
optionnel

Exemple : "string"

string (date-time)

lastname
optionnel

Exemple : "string"

string

level
optionnel

Exemple : "string"

string

mobile
optionnel

Exemple : "string"

string

nbFailedAttempts
optionnel

Exemple : 0

integer (int32)

otp
optionnel

Exemple : true

boolean

password
optionnel

Exemple : "string"

string

passwordExpirationDate
optionnel

Exemple : "string"

string (date-time)

phone
optionnel

Exemple : "string"

string

profileGroup
optionnel

Exemple : "GroupDto"

GroupDto

proofTenantIdentifier
optionnel

Exemple : 0

integer (int32)

readonly
optionnel

Exemple : true

boolean

removingDate
optionnel

Exemple : "string"

string (date-time)

siteCode
optionnel

Exemple : "string"

string

status
optionnel

Exemple : "string"

enum (ANONYM, BLOCKED, DISABLED, ENABLED, REMOVED)

subrogeable
optionnel

Exemple : true

boolean

superUser
optionnel

Exemple : "string"

string

superUserIdentifier
optionnel

Exemple : "string"

string

tenantsByApp
optionnel

Exemple : [ "TenantInformationDto" ]

< TenantInformationDto > array

type
optionnel

Exemple : "string"

enum (GENERIC, NOMINATIVE)

username
optionnel

Exemple : "string"

string

3.6. BasicCustomerDto

Nom Description Schéma

companyName
optionnel

Exemple : "string"

string

graphicIdentity
optionnel

Exemple : "GraphicIdentityDto"

GraphicIdentityDto

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

3.7. CustomerDto

Nom Description Schéma

address
optionnel

Exemple : "AddressDto"

AddressDto

code
optionnel

Exemple : "string"

string

companyName
optionnel

Exemple : "string"

string

defaultEmailDomain
optionnel

Exemple : "string"

string

emailDomains
optionnel

Exemple : [ "string" ]

< string > array

enabled
optionnel

Exemple : true

boolean

gdprAlert
optionnel

Exemple : true

boolean

gdprAlertDelay
optionnel

Exemple : 0

integer (int32)

hasCustomGraphicIdentity
optionnel

Exemple : true

boolean

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

internalCode
optionnel

Exemple : "string"

string

language
optionnel

Exemple : "string"

enum (ENGLISH, FRENCH, GERMANY)

name
optionnel

Exemple : "string"

string

otp
optionnel

Exemple : "string"

enum (DISABLED, MANDATORY, OPTIONAL)

owners
optionnel

Exemple : [ "OwnerDto" ]

< OwnerDto > array

passwordRevocationDelay
optionnel

Exemple : 0

integer (int32)

portalMessage
optionnel

Exemple : "string"

string

portalTitle
optionnel

Exemple : "string"

string

readonly
optionnel

Exemple : true

boolean

subrogeable
optionnel

Exemple : true

boolean

themeColors
optionnel

Exemple : {
"string" : "string"
}

< string, string > map

3.8. ExternalParametersDto

Nom Description Schéma

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

parameters
optionnel

Exemple : [ "ParameterDto" ]

< ParameterDto > array

3.9. GrantedAuthority

Nom Description Schéma

authority
optionnel

Exemple : "string"

string

3.10. GraphicIdentityDto

Nom Description Schéma

footerDataBase64
optionnel

Exemple : "string"

string

hasCustomGraphicIdentity
optionnel

Exemple : true

boolean

headerDataBase64
optionnel

Exemple : "string"

string

portalDataBase64
optionnel

Exemple : "string"

string

portalMessage
optionnel

Exemple : "string"

string

portalTitle
optionnel

Exemple : "string"

string

themeColors
optionnel

Exemple : {
"string" : "string"
}

< string, string > map

3.11. GroupDto

Nom Description Schéma

customerId
optionnel

Exemple : "string"

string

description
optionnel

Exemple : "string"

string

enabled
optionnel

Exemple : true

boolean

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

level
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

profileIds
optionnel

Exemple : [ "string" ]

< string > array

profiles
optionnel

Exemple : [ "ProfileDto" ]

< ProfileDto > array

readonly
optionnel

Exemple : true

boolean

usersCount
optionnel

Exemple : 0

integer (int64)

3.12. HitsDto

Nom Description Schéma

limit
optionnel

Exemple : 0

integer (int32)

offset
optionnel

Exemple : 0

integer (int32)

size
optionnel

Exemple : 0

integer (int32)

total
optionnel

Exemple : 0

integer (int32)

3.13. IdentityProviderDto

Nom Description Schéma

customerId
optionnel

Exemple : "string"

string

enabled
optionnel

Exemple : true

boolean

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

idpMetadata
optionnel

Exemple : "string"

string

internal
optionnel

Exemple : true

boolean

keystoreBase64
optionnel

Exemple : "string"

string

keystorePassword
optionnel

Exemple : "string"

string

mailAttribute
optionnel

Exemple : "string"

string

maximumAuthenticationLifetime
optionnel

Exemple : 0

integer (int32)

name
optionnel

Exemple : "string"

string

patterns
optionnel

Exemple : [ "string" ]

< string > array

privateKeyPassword
optionnel

Exemple : "string"

string

readonly
optionnel

Exemple : true

boolean

spMetadata
optionnel

Exemple : "string"

string

technicalName
optionnel

Exemple : "string"

string

3.14. InputStream

Type : object

3.15. JsonNode

Type : object

3.16. LogbookEventDto

Nom Description Schéma

agId
optionnel

Exemple : "string"

string

agIdApp
optionnel

Exemple : "string"

string

agIdExt
optionnel

Exemple : "string"

string

evDateTime
optionnel

Exemple : "string"

string

evDetData
optionnel

Exemple : "string"

string

evId
optionnel

Exemple : "string"

string

evIdAppSession
optionnel

Exemple : "string"

string

evIdReq
optionnel

Exemple : "string"

string

evParentId
optionnel

Exemple : "string"

string

evType
optionnel

Exemple : "string"

string

evTypeProc
optionnel

Exemple : "string"

string

id
optionnel

Exemple : "string"

string

obId
optionnel

Exemple : "string"

string

obIdReq
optionnel

Exemple : "string"

string

outDetail
optionnel

Exemple : "string"

string

outMessg
optionnel

Exemple : "string"

string

outcome
optionnel

Exemple : "string"

string

rightsStatementIdentifier
optionnel

Exemple : "string"

string

3.17. LogbookLifeCycleResponseDto

Nom Description Schéma

$hits
optionnel

Exemple : "HitsDto"

HitsDto

$results
optionnel

Exemple : [ "LogbookLifecycleDto" ]

< LogbookLifecycleDto > array

3.18. LogbookLifecycleDto

Nom Description Schéma

_id
optionnel

Exemple : "string"

string

_tenant
optionnel

Exemple : 0

integer (int32)

_v
optionnel

Exemple : 0

integer (int32)

agId
optionnel

Exemple : "string"

string

agIdApp
optionnel

Exemple : "string"

string

agIdExt
optionnel

Exemple : "string"

string

evDateTime
optionnel

Exemple : "string"

string

evDetData
optionnel

Exemple : "string"

string

evId
optionnel

Exemple : "string"

string

evIdAppSession
optionnel

Exemple : "string"

string

evIdReq
optionnel

Exemple : "string"

string

evParentId
optionnel

Exemple : "string"

string

evType
optionnel

Exemple : "string"

string

evTypeProc
optionnel

Exemple : "string"

string

events
optionnel

Exemple : [ "LogbookEventDto" ]

< LogbookEventDto > array

obId
optionnel

Exemple : "string"

string

obIdReq
optionnel

Exemple : "string"

string

outDetail
optionnel

Exemple : "string"

string

outMessg
optionnel

Exemple : "string"

string

outcome
optionnel

Exemple : "string"

string

rightsStatementIdentifier
optionnel

Exemple : "string"

string

3.19. LogbookOperationDto

Nom Description Schéma

agId
optionnel

Exemple : "string"

string

agIdApp
optionnel

Exemple : "string"

string

agIdExt
optionnel

Exemple : "string"

string

evDateTime
optionnel

Exemple : "string"

string

evDetData
optionnel

Exemple : "string"

string

evId
optionnel

Exemple : "string"

string

evIdAppSession
optionnel

Exemple : "string"

string

evIdReq
optionnel

Exemple : "string"

string

evParentId
optionnel

Exemple : "string"

string

evType
optionnel

Exemple : "string"

string

evTypeProc
optionnel

Exemple : "string"

string

events
optionnel

Exemple : [ "LogbookEventDto" ]

< LogbookEventDto > array

id
optionnel

Exemple : "string"

string

obId
optionnel

Exemple : "string"

string

obIdIn
optionnel

Exemple : "string"

string

obIdReq
optionnel

Exemple : "string"

string

outDetail
optionnel

Exemple : "string"

string

outMessg
optionnel

Exemple : "string"

string

outcome
optionnel

Exemple : "string"

string

rightsStatementIdentifier
optionnel

Exemple : "string"

string

3.20. LogbookOperationsResponseDto

Nom Description Schéma

$hits
optionnel

Exemple : "HitsDto"

HitsDto

$results
optionnel

Exemple : [ "LogbookOperationDto" ]

< LogbookOperationDto > array

3.21. LoginRequestDto

Nom Description Schéma

ip
optionnel

Exemple : "string"

string

password
optionnel

Exemple : "string"

string

surrogate
optionnel

Exemple : "string"

string

username
optionnel

Exemple : "string"

string

3.22. OwnerDto

Nom Description Schéma

address
optionnel

Exemple : "AddressDto"

AddressDto

code
optionnel

Exemple : "string"

string

companyName
optionnel

Exemple : "string"

string

customerId
optionnel

Exemple : "string"

string

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

internalCode
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

readonly
optionnel

Exemple : true

boolean

3.23. PaginatedValuesDto«CustomerDto»

Nom Description Schéma

hasMore
optionnel

Exemple : true

boolean

pageNum
optionnel

Exemple : 0

integer (int32)

pageSize
optionnel

Exemple : 0

integer (int32)

values
optionnel

Exemple : [ "CustomerDto" ]

< CustomerDto > array

3.24. PaginatedValuesDto«GroupDto»

Nom Description Schéma

hasMore
optionnel

Exemple : true

boolean

pageNum
optionnel

Exemple : 0

integer (int32)

pageSize
optionnel

Exemple : 0

integer (int32)

values
optionnel

Exemple : [ "GroupDto" ]

< GroupDto > array

3.25. PaginatedValuesDto«ProfileDto»

Nom Description Schéma

hasMore
optionnel

Exemple : true

boolean

pageNum
optionnel

Exemple : 0

integer (int32)

pageSize
optionnel

Exemple : 0

integer (int32)

values
optionnel

Exemple : [ "ProfileDto" ]

< ProfileDto > array

3.26. PaginatedValuesDto«UserDto»

Nom Description Schéma

hasMore
optionnel

Exemple : true

boolean

pageNum
optionnel

Exemple : 0

integer (int32)

pageSize
optionnel

Exemple : 0

integer (int32)

values
optionnel

Exemple : [ "UserDto" ]

< UserDto > array

3.27. ParameterDto

Nom Description Schéma

key
optionnel

Exemple : "string"

string

value
optionnel

Exemple : "string"

string

3.28. ProfileDto

Nom Description Schéma

applicationName
optionnel

Exemple : "string"

string

customerId
optionnel

Exemple : "string"

string

description
optionnel

Exemple : "string"

string

enabled
optionnel

Exemple : true

boolean

externalParamId
optionnel

Exemple : "string"

string

externalParamIdentifier
optionnel

Exemple : "string"

string

groupsCount
optionnel

Exemple : 0

integer (int64)

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

level
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

readonly
optionnel

Exemple : true

boolean

roles
optionnel

Exemple : [ "Role" ]

< Role > array

tenantIdentifier
optionnel

Exemple : 0

integer (int32)

tenantName
optionnel

Exemple : "string"

string

usersCount
optionnel

Exemple : 0

integer (int64)

3.29. Resource

Nom Description Schéma

description
optionnel

Exemple : "string"

string

file
optionnel

Exemple : "file"

file

filename
optionnel

Exemple : "string"

string

inputStream
optionnel

Exemple : "InputStream"

InputStream

open
optionnel

Exemple : true

boolean

readable
optionnel

Exemple : true

boolean

uri
optionnel

Exemple : "string"

string (uri)

url
optionnel

Exemple : "string"

string (url)

3.30. Role

Nom Description Schéma

name
optionnel

Exemple : "string"

string

3.31. SubrogationDto

Nom Description Schéma

date
optionnel

Exemple : "string"

string (date-time)

id
optionnel

Exemple : "string"

string

status
optionnel

Exemple : "string"

enum (ACCEPTED, CREATED)

superUser
optionnel

Exemple : "string"

string

superUserCustomerId
optionnel

Exemple : "string"

string

surrogate
optionnel

Exemple : "string"

string

surrogateCustomerId
optionnel

Exemple : "string"

string

3.32. TenantDto

Nom Description Schéma

accessContractHoldingIdentifier
optionnel

Exemple : "string"

string

accessContractLogbookIdentifier
optionnel

Exemple : "string"

string

customerId
optionnel

Exemple : "string"

string

enabled
optionnel

Exemple : true

boolean

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : 0

integer (int32)

ingestContractHoldingIdentifier
optionnel

Exemple : "string"

string

itemIngestContractIdentifier
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

ownerId
optionnel

Exemple : "string"

string

proof
optionnel

Exemple : true

boolean

readonly
optionnel

Exemple : true

boolean

3.33. TenantInformationDto

Nom Description Schéma

name
optionnel

Exemple : "string"

string

tenants
optionnel

Exemple : [ "TenantDto" ]

< TenantDto > array

3.34. UserDto

Nom Description Schéma

address
optionnel

Exemple : "AddressDto"

AddressDto

analytics
optionnel

Exemple : "AnalyticsDto"

AnalyticsDto

customerId
optionnel

Exemple : "string"

string

disablingDate
optionnel

Exemple : "string"

string (date-time)

email
optionnel

Exemple : "string"

string

firstname
optionnel

Exemple : "string"

string

groupId
optionnel

Exemple : "string"

string

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

internalCode
optionnel

Exemple : "string"

string

language
optionnel

Exemple : "string"

string

lastConnection
optionnel

Exemple : "string"

string (date-time)

lastname
optionnel

Exemple : "string"

string

level
optionnel

Exemple : "string"

string

mobile
optionnel

Exemple : "string"

string

nbFailedAttempts
optionnel

Exemple : 0

integer (int32)

otp
optionnel

Exemple : true

boolean

passwordExpirationDate
optionnel

Exemple : "string"

string (date-time)

phone
optionnel

Exemple : "string"

string

readonly
optionnel

Exemple : true

boolean

removingDate
optionnel

Exemple : "string"

string (date-time)

siteCode
optionnel

Exemple : "string"

string

status
optionnel

Exemple : "string"

enum (ANONYM, BLOCKED, DISABLED, ENABLED, REMOVED)

subrogeable
optionnel

Exemple : true

boolean

type
optionnel

Exemple : "string"

enum (GENERIC, NOMINATIVE)