1. Vue générale
Ces APIS sont utilisés pour configurer les clients, tenants, idp, groupes, profiles, et utilisateurs.
1.1. Information de version
Version : v1
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 External Controller
-
groups : Profiles Groups Management
-
identityproviders : Identity Providers Management
-
logbooks : Logbook External Controller
-
owners : Owners Management
-
profiles : Profiles Management
-
status : Status check and autotest
-
subrogations : Subrogation Management
-
tenants : Tenants Management
-
user-external-controller : User External Controller
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 |
criteria |
string |
Query |
embedded |
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.1.2. patch
PATCH /iam/v1/applications/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Body |
partialDto |
partialDto |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Consomme
-
application/json
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 |
dto |
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 |
authToken |
string |
Query |
superUser |
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 |
password |
string |
Header |
username |
username |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
string |
Consomme
-
application/json
Exemple de réponse HTTP
Réponse 200
"string"
2.2.4. getSubrogationsBySuperUserId
GET /iam/v1/cas/subrogations
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Query |
superUserId |
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 |
string |
|
Query |
embedded |
embedded |
string |
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 |
---|---|---|
FormData |
customerDto.address.city |
string |
FormData |
customerDto.address.country |
string |
FormData |
customerDto.address.street |
string |
FormData |
customerDto.address.zipCode |
string |
FormData |
customerDto.code |
string |
FormData |
customerDto.companyName |
string |
FormData |
customerDto.defaultEmailDomain |
string |
FormData |
customerDto.emailDomains |
< string > array(multi) |
FormData |
customerDto.enabled |
boolean |
FormData |
customerDto.gdprAlert |
boolean |
FormData |
customerDto.gdprAlertDelay |
integer (int32) |
FormData |
customerDto.hasCustomGraphicIdentity |
boolean |
FormData |
customerDto.id |
string |
FormData |
customerDto.identifier |
string |
FormData |
customerDto.internalCode |
string |
FormData |
customerDto.language |
string |
FormData |
customerDto.name |
string |
FormData |
customerDto.otp |
string |
FormData |
customerDto.owners[0].address.city |
string |
FormData |
customerDto.owners[0].address.country |
string |
FormData |
customerDto.owners[0].address.street |
string |
FormData |
customerDto.owners[0].address.zipCode |
string |
FormData |
customerDto.owners[0].code |
string |
FormData |
customerDto.owners[0].companyName |
string |
FormData |
customerDto.owners[0].customerId |
string |
FormData |
customerDto.owners[0].id |
string |
FormData |
customerDto.owners[0].identifier |
string |
FormData |
customerDto.owners[0].internalCode |
string |
FormData |
customerDto.owners[0].name |
string |
FormData |
customerDto.owners[0].readonly |
boolean |
FormData |
customerDto.passwordRevocationDelay |
integer (int32) |
FormData |
customerDto.portalMessage |
string |
FormData |
customerDto.portalTitle |
string |
FormData |
customerDto.readonly |
boolean |
FormData |
customerDto.subrogeable |
boolean |
FormData |
footer |
file |
FormData |
header |
file |
FormData |
logo |
file |
FormData |
portal |
file |
FormData |
tenantName |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
201 |
Created |
Consomme
-
multipart/form-data
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. getAll
GET /iam/v1/customers
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Query |
criteria |
criteria |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< CustomerDto > array |
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.3. checkExist
HEAD /iam/v1/customers/check
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Query |
criteria |
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. Get Gdpr Setting Status
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 |
Exemple de requête HTTP
Requête path
/iam/v1/customers/me
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 |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Exemple de requête HTTP
Requête path
/iam/v1/customers/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 |
id |
string |
Body |
dto |
dto |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 customer entity
PATCH /iam/v1/customers/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Query |
footer |
file |
|
Query |
header |
file |
|
Query |
partialCustomerDto |
object |
|
Query |
portal |
file |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
id |
string |
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 |
id |
string |
Query |
type |
type |
enum (FOOTER, HEADER, PORTAL) |
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 External Controller
2.4.1. getMyExternalParameters
GET /iam/v1/externalparameters/me
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
dto |
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. getAllPaginated
GET /iam/v1/groups
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Query |
criteria |
criteria |
string |
Query |
direction |
direction |
enum (ASC, DESC) |
Query |
embedded |
embedded |
string |
Query |
orderBy |
orderBy |
string |
Query |
page |
page |
string |
Query |
size |
size |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Exemple de requête HTTP
Requête path
/iam/v1/groups
Requête query
{
"criteria" : "string",
"direction" : "string",
"embedded" : "string",
"orderBy" : "string",
"page" : "string",
"size" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
"hasMore" : true,
"pageNum" : 0,
"pageSize" : 0,
"values" : [ {
"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 |
criteria |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
Consomme
-
application/json
2.5.4. getLevels
GET /iam/v1/groups/levels
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Query |
criteria |
criteria |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< string > array |
Exemple de réponse HTTP
Réponse 200
[ "string" ]
2.5.5. getOne
GET /iam/v1/groups/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Query |
embedded |
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. patch
PATCH /iam/v1/groups/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Body |
partialDto |
partialDto |
object |
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.7. findHistoryById
GET /iam/v1/groups/{id}/history
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
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 |
dto |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
criteria |
string |
Query |
embedded |
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 |
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 |
id |
string |
Query |
embedded |
embedded |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Exemple de requête HTTP
Requête path
/iam/v1/providers/string
Requête query
{
"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 |
id |
string |
Body |
partialDto |
partialDto |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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
Logbook External Controller
2.7.1. Get logbook object lifecycle by archive unit id
GET /v1/logbooks/objectslifecycles/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 logbook operations by json select
POST /v1/logbooks/operations
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Body |
select |
select |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 operation by id
GET /v1/logbooks/operations/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 file for a given operation
GET /v1/logbooks/operations/{id}/download/atr
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Exemple de requête HTTP
Requête path
/v1/logbooks/operations/string/download/atr
Exemple de réponse HTTP
Réponse 200
{
"description" : "string",
"file" : "file",
"filename" : "string",
"inputStream" : { },
"open" : true,
"readable" : true,
"uri" : "string",
"url" : "string"
}
2.7.5. Download the manifest for a given operation
GET /v1/logbooks/operations/{id}/download/manifest
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Exemple de requête HTTP
Requête path
/v1/logbooks/operations/string/download/manifest
Exemple de réponse HTTP
Réponse 200
{
"description" : "string",
"file" : "file",
"filename" : "string",
"inputStream" : { },
"open" : true,
"readable" : true,
"uri" : "string",
"url" : "string"
}
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 |
---|---|---|---|
Path |
downloadType |
downloadType |
string |
Path |
id |
id |
string |
Exemple de requête HTTP
Requête path
/v1/logbooks/operations/string/download/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.7.7. Get logbook unit lifecycle by archive unit id
GET /v1/logbooks/unitlifecycles/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
dto |
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 |
criteria |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
Consomme
-
application/json
2.8.3. getOne
GET /iam/v1/owners/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Exemple de requête HTTP
Requête path
/iam/v1/owners/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 |
id |
string |
Body |
dto |
dto |
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 |
id |
string |
Body |
partialDto |
partialDto |
object |
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 |
id |
string |
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 |
dto |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
criteria |
string |
Query |
embedded |
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 |
criteria |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
Consomme
-
application/json
2.9.4. getLevels
GET /iam/v1/profiles/levels
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Query |
criteria |
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"
}
Exemple de réponse HTTP
Réponse 200
[ "string" ]
2.9.5. getOne
GET /iam/v1/profiles/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Query |
embedded |
embedded |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Exemple de requête HTTP
Requête path
/iam/v1/profiles/string
Requête query
{
"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 |
id |
string |
Body |
partialDto |
partialDto |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
id |
string |
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 |
Exemple de requête HTTP
Requête path
/autotest
Exemple de réponse HTTP
Réponse 200
"string"
2.10.2. status
GET /status
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
string |
Exemple de requête HTTP
Requête path
/status
Exemple de réponse HTTP
Réponse 200
"string"
2.11. Subrogations
Subrogation Management
2.11.1. create
POST /iam/v1/subrogations
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Body |
dto |
dto |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
criteria |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< SubrogationDto > array |
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 |
id |
string |
Exemple de requête HTTP
Requête path
/iam/v1/subrogations/groups/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 |
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 |
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 |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
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. getGenericUsers
GET /iam/v1/subrogations/users/generic
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Query |
criteria |
criteria |
string |
Query |
direction |
direction |
enum (ASC, DESC) |
Query |
orderBy |
orderBy |
string |
Query |
page |
page |
string |
Query |
size |
size |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Exemple de requête HTTP
Requête path
/iam/v1/subrogations/users/generic
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 |
id |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Exemple de requête HTTP
Requête path
/iam/v1/subrogations/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 |
id |
string |
Body |
dto |
dto |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
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 |
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 |
dto |
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 |
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 |
criteria |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
Consomme
-
application/json
2.12.4. getOne
GET /iam/v1/tenants/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Exemple de requête HTTP
Requête path
/iam/v1/tenants/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 |
id |
string |
Body |
dto |
dto |
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 |
id |
string |
Body |
partialDto |
partialDto |
object |
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 |
id |
string |
Exemple de requête HTTP
Requête path
/iam/v1/tenants/string/history
2.13. User-external-controller
User External Controller
2.13.1. create
POST /iam/v1/users
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Body |
dto |
dto |
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 |
criteria |
string |
Query |
direction |
direction |
enum (ASC, DESC) |
Query |
orderBy |
orderBy |
string |
Query |
page |
page |
string |
Query |
size |
size |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
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 |
partialDto |
object |
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 |
criteria |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
Consomme
-
application/json
2.13.5. getLevels
GET /iam/v1/users/levels
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Query |
criteria |
criteria |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< string > array |
Exemple de réponse HTTP
Réponse 200
[ "string" ]
2.13.6. patchMe
PATCH /iam/v1/users/me
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Body |
partialDto |
partialDto |
object |
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.7. getOne
GET /iam/v1/users/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Path |
id |
id |
string |
Exemple de requête HTTP
Requête path
/iam/v1/users/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 |
id |
string |
Body |
dto |
dto |
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 |
id |
string |
Body |
partialDto |
partialDto |
object |
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 |
id |
string |
Exemple de requête HTTP
Requête path
/iam/v1/users/string/history
3. Définitions
3.1. AddressDto
Nom | Description | Schéma |
---|---|---|
city |
Exemple : |
string |
country |
Exemple : |
string |
street |
Exemple : |
string |
zipCode |
Exemple : |
string |
3.2. AnalyticsDto
Nom | Description | Schéma |
---|---|---|
applications |
Exemple : |
< ApplicationAnalyticsDto > array |
lastTenantIdentifier |
Exemple : |
integer (int32) |
3.3. ApplicationAnalyticsDto
Nom | Description | Schéma |
---|---|---|
accessCounter |
Exemple : |
integer (int32) |
applicationId |
Exemple : |
string |
lastAccess |
Exemple : |
string (date-time) |
3.4. ApplicationDto
Nom | Description | Schéma |
---|---|---|
category |
Exemple : |
string |
hasCustomerList |
Exemple : |
boolean |
hasHighlight |
Exemple : |
boolean |
hasTenantList |
Exemple : |
boolean |
icon |
Exemple : |
string |
id |
Exemple : |
string |
identifier |
Exemple : |
string |
name |
Exemple : |
string |
position |
Exemple : |
integer (int32) |
target |
Exemple : |
string |
tooltip |
Exemple : |
string |
url |
Exemple : |
string |
3.5. CustomerDto
Nom | Description | Schéma |
---|---|---|
address |
Exemple : |
|
code |
Exemple : |
string |
companyName |
Exemple : |
string |
defaultEmailDomain |
Exemple : |
string |
emailDomains |
Exemple : |
< string > array |
enabled |
Exemple : |
boolean |
gdprAlert |
Exemple : |
boolean |
gdprAlertDelay |
Exemple : |
integer (int32) |
hasCustomGraphicIdentity |
Exemple : |
boolean |
id |
Exemple : |
string |
identifier |
Exemple : |
string |
internalCode |
Exemple : |
string |
language |
Exemple : |
enum (ENGLISH, FRENCH, GERMANY) |
name |
Exemple : |
string |
otp |
Exemple : |
enum (DISABLED, MANDATORY, OPTIONAL) |
owners |
Exemple : |
< OwnerDto > array |
passwordRevocationDelay |
Exemple : |
integer (int32) |
portalMessage |
Exemple : |
string |
portalTitle |
Exemple : |
string |
readonly |
Exemple : |
boolean |
subrogeable |
Exemple : |
boolean |
themeColors |
Exemple : |
< string, string > map |
3.6. ExternalParametersDto
Nom | Description | Schéma |
---|---|---|
id |
Exemple : |
string |
identifier |
Exemple : |
string |
name |
Exemple : |
string |
parameters |
Exemple : |
< ParameterDto > array |
3.7. GroupDto
Nom | Description | Schéma |
---|---|---|
customerId |
Exemple : |
string |
description |
Exemple : |
string |
enabled |
Exemple : |
boolean |
id |
Exemple : |
string |
identifier |
Exemple : |
string |
level |
Exemple : |
string |
name |
Exemple : |
string |
profileIds |
Exemple : |
< string > array |
profiles |
Exemple : |
< ProfileDto > array |
readonly |
Exemple : |
boolean |
usersCount |
Exemple : |
integer (int64) |
3.8. HitsDto
Nom | Description | Schéma |
---|---|---|
limit |
Exemple : |
integer (int32) |
offset |
Exemple : |
integer (int32) |
size |
Exemple : |
integer (int32) |
total |
Exemple : |
integer (int32) |
3.9. IdentityProviderDto
Nom | Description | Schéma |
---|---|---|
customerId |
Exemple : |
string |
enabled |
Exemple : |
boolean |
id |
Exemple : |
string |
identifier |
Exemple : |
string |
idpMetadata |
Exemple : |
string |
internal |
Exemple : |
boolean |
keystoreBase64 |
Exemple : |
string |
keystorePassword |
Exemple : |
string |
mailAttribute |
Exemple : |
string |
maximumAuthenticationLifetime |
Exemple : |
integer (int32) |
name |
Exemple : |
string |
patterns |
Exemple : |
< string > array |
privateKeyPassword |
Exemple : |
string |
readonly |
Exemple : |
boolean |
spMetadata |
Exemple : |
string |
technicalName |
Exemple : |
string |
3.10. InputStream
Type : object
3.11. JsonNode
Type : object
3.12. LogbookEventDto
Nom | Description | Schéma |
---|---|---|
agId |
Exemple : |
string |
agIdApp |
Exemple : |
string |
agIdExt |
Exemple : |
string |
evDateTime |
Exemple : |
string |
evDetData |
Exemple : |
string |
evId |
Exemple : |
string |
evIdAppSession |
Exemple : |
string |
evIdReq |
Exemple : |
string |
evParentId |
Exemple : |
string |
evType |
Exemple : |
string |
evTypeProc |
Exemple : |
string |
id |
Exemple : |
string |
obId |
Exemple : |
string |
obIdReq |
Exemple : |
string |
outDetail |
Exemple : |
string |
outMessg |
Exemple : |
string |
outcome |
Exemple : |
string |
rightsStatementIdentifier |
Exemple : |
string |
3.13. LogbookLifeCycleResponseDto
Nom | Description | Schéma |
---|---|---|
$hits |
Exemple : |
|
$results |
Exemple : |
< LogbookLifecycleDto > array |
3.14. LogbookLifecycleDto
Nom | Description | Schéma |
---|---|---|
_id |
Exemple : |
string |
_tenant |
Exemple : |
integer (int32) |
_v |
Exemple : |
integer (int32) |
agId |
Exemple : |
string |
agIdApp |
Exemple : |
string |
agIdExt |
Exemple : |
string |
evDateTime |
Exemple : |
string |
evDetData |
Exemple : |
string |
evId |
Exemple : |
string |
evIdAppSession |
Exemple : |
string |
evIdReq |
Exemple : |
string |
evParentId |
Exemple : |
string |
evType |
Exemple : |
string |
evTypeProc |
Exemple : |
string |
events |
Exemple : |
< LogbookEventDto > array |
obId |
Exemple : |
string |
obIdReq |
Exemple : |
string |
outDetail |
Exemple : |
string |
outMessg |
Exemple : |
string |
outcome |
Exemple : |
string |
rightsStatementIdentifier |
Exemple : |
string |
3.15. LogbookOperationDto
Nom | Description | Schéma |
---|---|---|
agId |
Exemple : |
string |
agIdApp |
Exemple : |
string |
agIdExt |
Exemple : |
string |
evDateTime |
Exemple : |
string |
evDetData |
Exemple : |
string |
evId |
Exemple : |
string |
evIdAppSession |
Exemple : |
string |
evIdReq |
Exemple : |
string |
evParentId |
Exemple : |
string |
evType |
Exemple : |
string |
evTypeProc |
Exemple : |
string |
events |
Exemple : |
< LogbookEventDto > array |
id |
Exemple : |
string |
obId |
Exemple : |
string |
obIdIn |
Exemple : |
string |
obIdReq |
Exemple : |
string |
outDetail |
Exemple : |
string |
outMessg |
Exemple : |
string |
outcome |
Exemple : |
string |
rightsStatementIdentifier |
Exemple : |
string |
3.16. LogbookOperationsResponseDto
Nom | Description | Schéma |
---|---|---|
$hits |
Exemple : |
|
$results |
Exemple : |
< LogbookOperationDto > array |
3.17. LoginRequestDto
Nom | Description | Schéma |
---|---|---|
ip |
Exemple : |
string |
password |
Exemple : |
string |
surrogate |
Exemple : |
string |
username |
Exemple : |
string |
3.18. OwnerDto
Nom | Description | Schéma |
---|---|---|
address |
Exemple : |
|
code |
Exemple : |
string |
companyName |
Exemple : |
string |
customerId |
Exemple : |
string |
id |
Exemple : |
string |
identifier |
Exemple : |
string |
internalCode |
Exemple : |
string |
name |
Exemple : |
string |
readonly |
Exemple : |
boolean |
3.19. PaginatedValuesDto«CustomerDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< CustomerDto > array |
3.20. PaginatedValuesDto«GroupDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< GroupDto > array |
3.21. PaginatedValuesDto«ProfileDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< ProfileDto > array |
3.22. PaginatedValuesDto«UserDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< UserDto > array |
3.23. ParameterDto
Nom | Description | Schéma |
---|---|---|
key |
Exemple : |
string |
value |
Exemple : |
string |
3.24. ProfileDto
Nom | Description | Schéma |
---|---|---|
applicationName |
Exemple : |
string |
customerId |
Exemple : |
string |
description |
Exemple : |
string |
enabled |
Exemple : |
boolean |
externalParamId |
Exemple : |
string |
externalParamIdentifier |
Exemple : |
string |
groupsCount |
Exemple : |
integer (int64) |
id |
Exemple : |
string |
identifier |
Exemple : |
string |
level |
Exemple : |
string |
name |
Exemple : |
string |
readonly |
Exemple : |
boolean |
roles |
Exemple : |
< Role > array |
tenantIdentifier |
Exemple : |
integer (int32) |
tenantName |
Exemple : |
string |
usersCount |
Exemple : |
integer (int64) |
3.25. Resource
Nom | Description | Schéma |
---|---|---|
description |
Exemple : |
string |
file |
Exemple : |
file |
filename |
Exemple : |
string |
inputStream |
Exemple : |
|
open |
Exemple : |
boolean |
readable |
Exemple : |
boolean |
uri |
Exemple : |
string (uri) |
url |
Exemple : |
string (url) |
3.26. Role
Nom | Description | Schéma |
---|---|---|
name |
Exemple : |
string |
3.27. SubrogationDto
Nom | Description | Schéma |
---|---|---|
date |
Exemple : |
string (date-time) |
id |
Exemple : |
string |
status |
Exemple : |
enum (ACCEPTED, CREATED) |
superUser |
Exemple : |
string |
superUserCustomerId |
Exemple : |
string |
surrogate |
Exemple : |
string |
surrogateCustomerId |
Exemple : |
string |
3.28. TenantDto
Nom | Description | Schéma |
---|---|---|
accessContractHoldingIdentifier |
Exemple : |
string |
accessContractLogbookIdentifier |
Exemple : |
string |
customerId |
Exemple : |
string |
enabled |
Exemple : |
boolean |
id |
Exemple : |
string |
identifier |
Exemple : |
integer (int32) |
ingestContractHoldingIdentifier |
Exemple : |
string |
itemIngestContractIdentifier |
Exemple : |
string |
name |
Exemple : |
string |
ownerId |
Exemple : |
string |
proof |
Exemple : |
boolean |
readonly |
Exemple : |
boolean |
3.29. UserDto
Nom | Description | Schéma |
---|---|---|
address |
Exemple : |
|
analytics |
Exemple : |
|
customerId |
Exemple : |
string |
disablingDate |
Exemple : |
string (date-time) |
email |
Exemple : |
string |
firstname |
Exemple : |
string |
groupId |
Exemple : |
string |
id |
Exemple : |
string |
identifier |
Exemple : |
string |
internalCode |
Exemple : |
string |
language |
Exemple : |
string |
lastConnection |
Exemple : |
string (date-time) |
lastname |
Exemple : |
string |
level |
Exemple : |
string |
mobile |
Exemple : |
string |
nbFailedAttempts |
Exemple : |
integer (int32) |
otp |
Exemple : |
boolean |
passwordExpirationDate |
Exemple : |
string (date-time) |
phone |
Exemple : |
string |
readonly |
Exemple : |
boolean |
removingDate |
Exemple : |
string (date-time) |
siteCode |
Exemple : |
string |
status |
Exemple : |
enum (ANONYM, BLOCKED, DISABLED, ENABLED, REMOVED) |
subrogeable |
Exemple : |
boolean |
type |
Exemple : |
enum (GENERIC, NOMINATIVE) |