1. Vue générale
This API is used by the UI to manage customers, tenants, identity providers, users with their profiles and their profiles groups. This API should be used by the Identity UI only.
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
-
customers : Customer Controller
-
groups : Group Controller
-
owners : Owner Controller
-
profiles : Profile Controller
-
providers : Provider Controller
-
tenants : Tenant Controller
-
users : User Controller
1.6. Produit
-
application/json
2. Ressources
2.1. Customers
Customer Controller
2.1.1. Create entity
POST /identity-api/customers
Paramètres
| Type | Nom | Schéma |
|---|---|---|
Query |
customerDto.address.city |
string |
Query |
customerDto.address.country |
string |
Query |
customerDto.address.street |
string |
Query |
customerDto.address.zipCode |
string |
Query |
customerDto.code |
string |
Query |
customerDto.companyName |
string |
Query |
customerDto.defaultEmailDomain |
string |
Query |
customerDto.emailDomains |
< string > array(multi) |
Query |
customerDto.enabled |
boolean |
Query |
customerDto.gdprAlert |
boolean |
Query |
customerDto.gdprAlertDelay |
integer (int32) |
Query |
customerDto.hasCustomGraphicIdentity |
boolean |
Query |
customerDto.id |
string |
Query |
customerDto.identifier |
string |
Query |
customerDto.internalCode |
string |
Query |
customerDto.language |
enum (ENGLISH, FRENCH, GERMANY) |
Query |
customerDto.name |
string |
Query |
customerDto.otp |
enum (DISABLED, MANDATORY, OPTIONAL) |
Query |
customerDto.owners[0].address.city |
string |
Query |
customerDto.owners[0].address.country |
string |
Query |
customerDto.owners[0].address.street |
string |
Query |
customerDto.owners[0].address.zipCode |
string |
Query |
customerDto.owners[0].code |
string |
Query |
customerDto.owners[0].companyName |
string |
Query |
customerDto.owners[0].customerId |
string |
Query |
customerDto.owners[0].id |
string |
Query |
customerDto.owners[0].identifier |
string |
Query |
customerDto.owners[0].internalCode |
string |
Query |
customerDto.owners[0].name |
string |
Query |
customerDto.owners[0].readonly |
boolean |
Query |
customerDto.passwordRevocationDelay |
integer (int32) |
Query |
customerDto.portalMessage |
string |
Query |
customerDto.portalTitle |
string |
Query |
customerDto.readonly |
boolean |
Query |
customerDto.subrogeable |
boolean |
Query |
footer |
file |
Query |
header |
file |
Query |
logo |
file |
Query |
portal |
file |
Query |
tenantName |
string |
Réponses
| Code HTTP | Description | Schéma |
|---|---|---|
201 |
Created |
Consomme
-
application/json -
multipart/form-data
Exemple de requête HTTP
Requête path
/identity-api/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.1.2. Get entities paginated
GET /identity-api/customers
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
/identity-api/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.1.3. Check entity exist by criteria
HEAD /identity-api/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
/identity-api/customers/check
Requête query
{
"criteria" : "string"
}
2.1.4. getGdprSettingStatus
GET /identity-api/customers/gdpr-status
Réponses
| Code HTTP | Description | Schéma |
|---|---|---|
200 |
OK |
boolean |
Exemple de requête HTTP
Requête path
/identity-api/customers/gdpr-status
2.1.5. getMyCustomer
GET /identity-api/customers/me
Réponses
| Code HTTP | Description | Schéma |
|---|---|---|
200 |
OK |
Exemple de requête HTTP
Requête path
/identity-api/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.1.6. Get entity
GET /identity-api/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
/identity-api/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.1.7. Update entity
PUT /identity-api/customers/{id}
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Path |
id |
id |
string |
Body |
entityDto |
entityDto |
Réponses
| Code HTTP | Description | Schéma |
|---|---|---|
200 |
OK |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/identity-api/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.1.8. Patch entity
PATCH /identity-api/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
/identity-api/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.1.9. get history by customer’s id
GET /identity-api/customers/{id}/history
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
/identity-api/customers/string/history
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.1.10. Get entity logo
GET /identity-api/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
/identity-api/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.2. Groups
Group Controller
2.2.1. Create entity
POST /identity-api/groups
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Body |
entityDto |
entityDto |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/identity-api/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 201
{
"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.2.2. Get all entities
GET /identity-api/groups
Paramètres
| Type | Nom | Description | Schéma | Défaut |
|---|---|---|---|---|
Query |
criteria |
criteria |
string |
|
Query |
embedded |
embedded |
string |
|
Exemple de requête HTTP
Requête path
/identity-api/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.2.3. Check entity exist by criteria
HEAD /identity-api/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
Exemple de requête HTTP
Requête path
/identity-api/groups/check
Requête query
{
"criteria" : "string"
}
2.2.4. getLevels
GET /identity-api/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 requête HTTP
Requête path
/identity-api/groups/levels
Requête query
{
"criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ "string" ]
2.2.5. Get entity, can be filter by enabled value
GET /identity-api/groups/{id}
Paramètres
| Type | Nom | Description | Schéma | Défaut |
|---|---|---|---|---|
Path |
id |
id |
string |
|
Query |
embedded |
embedded |
string |
|
Exemple de requête HTTP
Requête path
/identity-api/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.2.6. Update partially group
PATCH /identity-api/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.2.7. get history by group’s id
GET /identity-api/groups/{id}/history
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
/identity-api/groups/string/history
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.3. Owners
Owner Controller
2.3.1. Create entity
POST /identity-api/owners
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Body |
entityDto |
entityDto |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/identity-api/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 201
{
"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.3.2. Check entity exist by criteria
HEAD /identity-api/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
Exemple de requête HTTP
Requête path
/identity-api/owners/check
Requête query
{
"criteria" : "string"
}
2.3.3. Get entity
GET /identity-api/owners/{id}
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Path |
id |
id |
string |
Exemple de requête HTTP
Requête path
/identity-api/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.3.4. Update entity
PUT /identity-api/owners/{id}
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Path |
id |
id |
string |
Body |
entityDto |
entityDto |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/identity-api/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.3.5. Patch entity
PATCH /identity-api/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.3.6. get history by owner’s id
GET /identity-api/owners/{id}/history
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
/identity-api/owners/string/history
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.4. Profiles
Profile Controller
2.4.1. Create entity
POST /identity-api/profiles
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Body |
entityDto |
entityDto |
Réponses
| Code HTTP | Description | Schéma |
|---|---|---|
201 |
Created |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/identity-api/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 201
{
"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.4.2. Get entities paginated
GET /identity-api/profiles
Paramètres
| Type | Nom | Description | Schéma | Défaut |
|---|---|---|---|---|
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
/identity-api/profiles
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" : [ {
"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.4.3. Check entity exists by criteria
HEAD /identity-api/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
Exemple de requête HTTP
Requête path
/identity-api/profiles/check
Requête query
{
"criteria" : "string"
}
2.4.4. getLevels
GET /identity-api/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
/identity-api/profiles/levels
Requête query
{
"criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ "string" ]
2.4.5. Get entity
GET /identity-api/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
/identity-api/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.4.6. Update partially entity
PATCH /identity-api/profiles/{id}
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Path |
id |
id |
string |
Body |
profile |
profile |
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.4.7. get history by profile’s id
GET /identity-api/profiles/{id}/history
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
/identity-api/profiles/string/history
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.5. Providers
Provider Controller
2.5.1. Get all entities
GET /identity-api/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
/identity-api/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.5.2. Get entity
GET /identity-api/providers/{id}
Paramètres
| Type | Nom | Description | Schéma | Défaut |
|---|---|---|---|---|
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
/identity-api/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.5.3. Update partially provider
PATCH /identity-api/providers/{id}
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Path |
id |
id |
string |
Body |
provider |
provider |
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.5.4. Get metadata provider
GET /identity-api/providers/{id}/idpMetadata
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Path |
id |
id |
string |
Query |
tenantId |
tenantId |
integer (int32) |
Exemple de requête HTTP
Requête path
/identity-api/providers/string/idpMetadata
Requête query
{
"tenantId" : 0
}
Exemple de réponse HTTP
Réponse 200
{
"description" : "string",
"file" : "file",
"filename" : "string",
"inputStream" : { },
"open" : true,
"readable" : true,
"uri" : "string",
"url" : "string"
}
2.6. Tenants
Tenant Controller
2.6.1. Create entity
POST /identity-api/tenants
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Body |
entityDto |
entityDto |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/identity-api/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 201
{
"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.6.2. Get all entities
GET /identity-api/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.6.3. Check entity exist by criteria
HEAD /identity-api/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
Exemple de requête HTTP
Requête path
/identity-api/tenants/check
Requête query
{
"criteria" : "string"
}
2.6.4. Get entity
GET /identity-api/tenants/{id}
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Path |
id |
id |
string |
Exemple de requête HTTP
Requête path
/identity-api/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.6.5. Update entity
PUT /identity-api/tenants/{id}
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Path |
id |
id |
string |
Body |
entityDto |
entityDto |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/identity-api/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.6.6. Patch entity
PATCH /identity-api/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.6.7. get history by tenant id
GET /identity-api/tenants/{id}/history
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
/identity-api/tenants/string/history
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. Users
User Controller
2.7.1. Create entity
POST /identity-api/users
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Body |
dto |
dto |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/identity-api/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 201
{
"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.7.2. Find users by customer
GET /identity-api/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 |
integer (int32) |
Query |
size |
size |
integer (int32) |
Réponses
| Code HTTP | Description | Schéma |
|---|---|---|
200 |
OK |
Exemple de requête HTTP
Requête path
/identity-api/users
Requête query
{
"criteria" : "string",
"direction" : "string",
"orderBy" : "string",
"page" : 0,
"size" : 0
}
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.7.3. Check entity exist by params
HEAD /identity-api/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
Exemple de requête HTTP
Requête path
/identity-api/users/check
Requête query
{
"criteria" : "string"
}
2.7.4. getLevels
GET /identity-api/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 requête HTTP
Requête path
/identity-api/users/levels
Requête query
{
"criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ "string" ]
2.7.5. Get entity
GET /identity-api/users/{id}
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Path |
id |
id |
string |
Exemple de requête HTTP
Requête path
/identity-api/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.7.6. Update entity
PUT /identity-api/users/{id}
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
Body |
userDto |
userDto |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/identity-api/users/{id}
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.7.7. Patch entity
PATCH /identity-api/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.7.8. get history by user’s id
GET /identity-api/users/{id}/history
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
/identity-api/users/string/history
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"
} ]
}
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. 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.5. 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.6. HitsDto
| Nom | Description | Schéma |
|---|---|---|
limit |
Exemple : |
integer (int32) |
offset |
Exemple : |
integer (int32) |
size |
Exemple : |
integer (int32) |
total |
Exemple : |
integer (int32) |
3.7. 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.8. InputStream
Type : object
3.9. 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.10. 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.11. LogbookOperationsResponseDto
| Nom | Description | Schéma |
|---|---|---|
$hits |
Exemple : |
|
$results |
Exemple : |
< LogbookOperationDto > array |
3.12. 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.13. PaginatedValuesDto«CustomerDto»
| Nom | Description | Schéma |
|---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< CustomerDto > array |
3.14. PaginatedValuesDto«GroupDto»
| Nom | Description | Schéma |
|---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< GroupDto > array |
3.15. PaginatedValuesDto«ProfileDto»
| Nom | Description | Schéma |
|---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< ProfileDto > array |
3.16. PaginatedValuesDto«UserDto»
| Nom | Description | Schéma |
|---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< UserDto > array |
3.17. 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.18. 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.19. Role
| Nom | Description | Schéma |
|---|---|---|
name |
Exemple : |
string |
3.20. 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.21. 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) |