2911 lines
70 KiB
JSON
2911 lines
70 KiB
JSON
{
|
|
"openapi" : "3.0.1",
|
|
"paths" : {
|
|
"/api/admin/systeminformation/{domainIdentifier}/{path}" : {
|
|
"get" : {
|
|
"operationId" : "getSystemInformation",
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/SystemInformation"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/categories/ID-{categoryId}" : {
|
|
"get" : {
|
|
"operationId" : "getCategory",
|
|
"parameters" : [ {
|
|
"name" : "categoryId",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/CategoryData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put" : {
|
|
"operationId" : "updateCategory",
|
|
"parameters" : [ {
|
|
"name" : "catgoryId",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
} ],
|
|
"requestBody" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/CategoryData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : { }
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete" : {
|
|
"operationId" : "deleteCategory_2",
|
|
"parameters" : [ {
|
|
"name" : "categoryId",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/categories/{domainIdentifier}/{path}" : {
|
|
"get" : {
|
|
"operationId" : "getCategory_1",
|
|
"parameters" : [ {
|
|
"name" : "domainIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "path",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/CategoryData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put" : {
|
|
"operationId" : "updateCategory_1",
|
|
"parameters" : [ {
|
|
"name" : "domainIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "path",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"requestBody" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/CategoryData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete" : {
|
|
"operationId" : "deleteCategory_1",
|
|
"parameters" : [ {
|
|
"name" : "domainIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "path",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/categories/UUID-{categoryId}" : {
|
|
"get" : {
|
|
"operationId" : "getCategory_2",
|
|
"parameters" : [ {
|
|
"name" : "categoryId",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/CategoryData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/categories/UUID-{categoryUid}/subcategories" : {
|
|
"get" : {
|
|
"operationId" : "getSubCategories",
|
|
"parameters" : [ {
|
|
"name" : "categoryUuid",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "limit",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 20
|
|
}
|
|
}, {
|
|
"name" : "offset",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 20
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/ListViewCategoryData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/categories/ID-{categoryId}/subcategories" : {
|
|
"get" : {
|
|
"operationId" : "getSubCategories_1",
|
|
"parameters" : [ {
|
|
"name" : "categoryId",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
}, {
|
|
"name" : "limit",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 20
|
|
}
|
|
}, {
|
|
"name" : "offset",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 20
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/ListViewCategoryData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/categories/{domainIdentifier}/{path}/subcategories" : {
|
|
"get" : {
|
|
"operationId" : "getSubCategories_2",
|
|
"parameters" : [ {
|
|
"name" : "domainIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "path",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "limit",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 20
|
|
}
|
|
}, {
|
|
"name" : "offset",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 20
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/ListViewCategoryData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post" : {
|
|
"operationId" : "addNewSubCategory",
|
|
"parameters" : [ {
|
|
"name" : "domainIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "path",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"requestBody" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/CategoryData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/categories/UUID-{categoryUuid}" : {
|
|
"put" : {
|
|
"operationId" : "updateCategory_2",
|
|
"parameters" : [ {
|
|
"name" : "catgoryUuid",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"requestBody" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/CategoryData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : { }
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete" : {
|
|
"operationId" : "deleteCategory",
|
|
"parameters" : [ {
|
|
"name" : "categoryId",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/categories/{domainIdentifier}/{path}/objects" : {
|
|
"get" : {
|
|
"operationId" : "getObjectsInCategory",
|
|
"parameters" : [ {
|
|
"name" : "domainIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "path",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "limit",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32"
|
|
}
|
|
}, {
|
|
"name" : "offset",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/ListViewCategorizationData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post" : {
|
|
"operationId" : "addObjectToCategory",
|
|
"parameters" : [ {
|
|
"name" : "domainIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "path",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"requestBody" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/CategorizationData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/categories/UUID-{uuid}/objects" : {
|
|
"get" : {
|
|
"operationId" : "getObjectsInCategory_1",
|
|
"parameters" : [ {
|
|
"name" : "uuid",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "limit",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32"
|
|
}
|
|
}, {
|
|
"name" : "offset",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/ListViewCategorizationData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/categories/ID-{categoryId}/objects" : {
|
|
"get" : {
|
|
"operationId" : "getCategoryObjectsInCategory",
|
|
"parameters" : [ {
|
|
"name" : "categoryId",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
}, {
|
|
"name" : "limit",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32"
|
|
}
|
|
}, {
|
|
"name" : "offset",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/ListViewCategorizationData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/categories/ID-{categoryId}/objects/{objectIdentifier}" : {
|
|
"post" : {
|
|
"operationId" : "addObjectToCategory_1",
|
|
"parameters" : [ {
|
|
"name" : "categoryId",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
} ],
|
|
"requestBody" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/CategorizationData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete" : {
|
|
"operationId" : "removeObjectFromCategory",
|
|
"parameters" : [ {
|
|
"name" : "categoryId",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
}, {
|
|
"name" : "objectIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/categories/UUID-{categoryUuid}/objects/objectIdentifier" : {
|
|
"post" : {
|
|
"operationId" : "addObjectsToCategory",
|
|
"parameters" : [ {
|
|
"name" : "categoryUuid",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"requestBody" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/CategorizationData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/categories/{domainIdentifier}/{path}/objects/{objectIdentifier}" : {
|
|
"delete" : {
|
|
"operationId" : "removeObjectFromCategory_1",
|
|
"parameters" : [ {
|
|
"name" : "domainIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "path",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "objectIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/categories/UUID-{categoryId}/objects/objectIdentifier" : {
|
|
"delete" : {
|
|
"operationId" : "removeObjectsFromCategory",
|
|
"parameters" : [ {
|
|
"name" : "categoryId",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "objectIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/domains/{domainIdentifier}" : {
|
|
"get" : {
|
|
"operationId" : "getDomain",
|
|
"parameters" : [ {
|
|
"name" : "domainIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/DomainData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put" : {
|
|
"operationId" : "updateDomain",
|
|
"parameters" : [ {
|
|
"name" : "domainIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"requestBody" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/DomainData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : { }
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete" : {
|
|
"operationId" : "deleteDomain",
|
|
"parameters" : [ {
|
|
"name" : "domainIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/domains" : {
|
|
"get" : {
|
|
"operationId" : "getDomains",
|
|
"parameters" : [ {
|
|
"name" : "limit",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 20
|
|
}
|
|
}, {
|
|
"name" : "offset",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 0
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/ListViewDomainData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post" : {
|
|
"operationId" : "addDomain",
|
|
"requestBody" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/DomainData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/domains/{domainIdentifier}/owners" : {
|
|
"get" : {
|
|
"operationId" : "getOwners",
|
|
"parameters" : [ {
|
|
"name" : "domainIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "limit",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 20
|
|
}
|
|
}, {
|
|
"name" : "offset",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 0
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/ListViewDomainOwnershipData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/domains/{domainIdentifier}/owners/{ownerIdentifier}" : {
|
|
"put" : {
|
|
"operationId" : "addOwner",
|
|
"parameters" : [ {
|
|
"name" : "domainIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "ownerIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : { }
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete" : {
|
|
"operationId" : "removeOwner",
|
|
"parameters" : [ {
|
|
"name" : "domainIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "ownerIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/configurations/{confName}/settings/{setting}" : {
|
|
"get" : {
|
|
"operationId" : "getSetting",
|
|
"parameters" : [ {
|
|
"name" : "confName",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "setting",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"type" : "object"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put" : {
|
|
"operationId" : "updateSetting",
|
|
"parameters" : [ {
|
|
"name" : "confName",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "setting",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"requestBody" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"valueType" : {
|
|
"type" : "string",
|
|
"enum" : [ "ARRAY", "OBJECT", "STRING", "NUMBER", "TRUE", "FALSE", "NULL" ]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/configurations/{confName}" : {
|
|
"get" : {
|
|
"operationId" : "getConfiguration",
|
|
"parameters" : [ {
|
|
"name" : "confName",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/ConfigurationInfo"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/configurations/{confName}/settings" : {
|
|
"get" : {
|
|
"operationId" : "getSettings",
|
|
"parameters" : [ {
|
|
"name" : "confName",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"valueType" : {
|
|
"type" : "string",
|
|
"enum" : [ "ARRAY", "OBJECT", "STRING", "NUMBER", "TRUE", "FALSE", "NULL" ]
|
|
},
|
|
"empty" : {
|
|
"type" : "boolean"
|
|
}
|
|
},
|
|
"additionalProperties" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"valueType" : {
|
|
"type" : "string",
|
|
"enum" : [ "ARRAY", "OBJECT", "STRING", "NUMBER", "TRUE", "FALSE", "NULL" ]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/configurations" : {
|
|
"get" : {
|
|
"operationId" : "getConfigurations",
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/ConfigurationInfo"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/groups/{groupIdentifier}" : {
|
|
"get" : {
|
|
"operationId" : "getGroup",
|
|
"parameters" : [ {
|
|
"name" : "groupIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/GroupData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put" : {
|
|
"operationId" : "updateGroup",
|
|
"parameters" : [ {
|
|
"name" : "groupIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"requestBody" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/GroupData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete" : {
|
|
"operationId" : "deleteGroup",
|
|
"parameters" : [ {
|
|
"name" : "groupIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/groups" : {
|
|
"get" : {
|
|
"operationId" : "getGroups",
|
|
"parameters" : [ {
|
|
"name" : "limit",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 20
|
|
}
|
|
}, {
|
|
"name" : "offset",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 0
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/ListViewGroupData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post" : {
|
|
"operationId" : "addGroup",
|
|
"requestBody" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/GroupData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/groups/{groupIdentifier}/roles" : {
|
|
"get" : {
|
|
"operationId" : "getRoleMemberships",
|
|
"parameters" : [ {
|
|
"name" : "groupIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/PartyRoleMembership"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/groups/{groupIdentifier}/groups/{roleIdentifier}" : {
|
|
"put" : {
|
|
"operationId" : "addRoleMembership",
|
|
"parameters" : [ {
|
|
"name" : "groupIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "roleIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete" : {
|
|
"operationId" : "removeRoleMembership",
|
|
"parameters" : [ {
|
|
"name" : "groupIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "roleIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/groups/{groupIdentifier}/members/{userIdentifier}" : {
|
|
"put" : {
|
|
"operationId" : "addMember",
|
|
"parameters" : [ {
|
|
"name" : "groupIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "userIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete" : {
|
|
"operationId" : "removeMember",
|
|
"parameters" : [ {
|
|
"name" : "groupIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "userIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/groups/{groupIdentifier}/members" : {
|
|
"get" : {
|
|
"operationId" : "getMembers",
|
|
"parameters" : [ {
|
|
"name" : "groupIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "limit",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 20
|
|
}
|
|
}, {
|
|
"name" : "offset",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 0
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/ListViewGroupUserMembership"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/roles/{roleIdentifier}" : {
|
|
"get" : {
|
|
"operationId" : "getRole",
|
|
"parameters" : [ {
|
|
"name" : "roleIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/RoleData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put" : {
|
|
"operationId" : "updateRole",
|
|
"parameters" : [ {
|
|
"name" : "roleIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"requestBody" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/RoleData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete" : {
|
|
"operationId" : "deleteRole",
|
|
"parameters" : [ {
|
|
"name" : "roleIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/roles" : {
|
|
"get" : {
|
|
"operationId" : "getRoles",
|
|
"parameters" : [ {
|
|
"name" : "limit",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 20
|
|
}
|
|
}, {
|
|
"name" : "offset",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 0
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/ListViewRoleData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post" : {
|
|
"operationId" : "addRole",
|
|
"requestBody" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/RoleData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/roles/{roleIdentifier}/permissions" : {
|
|
"get" : {
|
|
"operationId" : "getPermissions",
|
|
"parameters" : [ {
|
|
"name" : "roleIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "limit",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 20
|
|
}
|
|
}, {
|
|
"name" : "offset",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 0
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/ListViewRolePermission"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post" : {
|
|
"operationId" : "addPermission",
|
|
"parameters" : [ {
|
|
"name" : "roleIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"requestBody" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/RolePermission"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/roles/{roleIdentifier}/permissions/{permissionIdentifier}" : {
|
|
"delete" : {
|
|
"operationId" : "removePermission",
|
|
"parameters" : [ {
|
|
"name" : "roleIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "permissionIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/roles/{roleIdentifier}/members/{partyIdentifier}" : {
|
|
"put" : {
|
|
"operationId" : "addMember_1",
|
|
"parameters" : [ {
|
|
"name" : "roleIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "partyIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete" : {
|
|
"operationId" : "removeMember_1",
|
|
"parameters" : [ {
|
|
"name" : "roleIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "partyIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/roles/{roleIdentifier}/members" : {
|
|
"get" : {
|
|
"operationId" : "getMembers_1",
|
|
"parameters" : [ {
|
|
"name" : "roleIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "limit",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 20
|
|
}
|
|
}, {
|
|
"name" : "offset",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 0
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/ListViewRolePartyMembership"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/users/{userIdentifier}/roles" : {
|
|
"get" : {
|
|
"operationId" : "getRoleMemberships_1",
|
|
"parameters" : [ {
|
|
"name" : "userIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/PartyRoleMembership"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/users/{userIdentifier}/groups/{roleIdentifier}" : {
|
|
"put" : {
|
|
"operationId" : "addRoleMembership_1",
|
|
"parameters" : [ {
|
|
"name" : "userIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "roleIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete" : {
|
|
"operationId" : "removeRoleMembership_1",
|
|
"parameters" : [ {
|
|
"name" : "userIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "roleIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/users/{userIdentifier}" : {
|
|
"get" : {
|
|
"operationId" : "getUser",
|
|
"parameters" : [ {
|
|
"name" : "userIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/UserData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put" : {
|
|
"operationId" : "updateUser",
|
|
"parameters" : [ {
|
|
"name" : "userIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"requestBody" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/UserData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete" : {
|
|
"operationId" : "deleteUser",
|
|
"parameters" : [ {
|
|
"name" : "userIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/users/{userIdentifier}/groups" : {
|
|
"get" : {
|
|
"operationId" : "getGroupMemberships",
|
|
"parameters" : [ {
|
|
"name" : "userIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/UserGroupMembership"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/users/{userIdentifier}/groups/{groupIdentifier}" : {
|
|
"put" : {
|
|
"operationId" : "addGroupMembership",
|
|
"parameters" : [ {
|
|
"name" : "userIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "groupIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete" : {
|
|
"operationId" : "removeGroupMembership",
|
|
"parameters" : [ {
|
|
"name" : "userIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
}, {
|
|
"name" : "groupIdentifier",
|
|
"in" : "path",
|
|
"required" : true,
|
|
"schema" : {
|
|
"type" : "string"
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/admin/users" : {
|
|
"get" : {
|
|
"operationId" : "getUsers",
|
|
"parameters" : [ {
|
|
"name" : "limit",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 20
|
|
}
|
|
}, {
|
|
"name" : "offset",
|
|
"in" : "query",
|
|
"schema" : {
|
|
"type" : "integer",
|
|
"format" : "int32",
|
|
"default" : 0
|
|
}
|
|
} ],
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/ListViewUserData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post" : {
|
|
"operationId" : "addUser",
|
|
"requestBody" : {
|
|
"content" : {
|
|
"application/json" : {
|
|
"schema" : {
|
|
"$ref" : "#/components/schemas/User"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses" : {
|
|
"default" : {
|
|
"description" : "default response",
|
|
"content" : {
|
|
"*/*" : { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"components" : {
|
|
"schemas" : {
|
|
"SystemInformation" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"entriesAsStream" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"parallel" : {
|
|
"type" : "boolean"
|
|
}
|
|
}
|
|
},
|
|
"empty" : {
|
|
"type" : "boolean"
|
|
},
|
|
"entries" : {
|
|
"uniqueItems" : true,
|
|
"type" : "array",
|
|
"items" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"value" : {
|
|
"type" : "string"
|
|
},
|
|
"key" : {
|
|
"type" : "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"AssociatedCategoryData" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"categoryId" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"uuid" : {
|
|
"type" : "string"
|
|
},
|
|
"uniqueId" : {
|
|
"type" : "string"
|
|
},
|
|
"name" : {
|
|
"type" : "string"
|
|
},
|
|
"title" : {
|
|
"$ref" : "#/components/schemas/LocalizedString"
|
|
},
|
|
"description" : {
|
|
"$ref" : "#/components/schemas/LocalizedString"
|
|
}
|
|
}
|
|
},
|
|
"CategoryData" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"categoryId" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"uuid" : {
|
|
"type" : "string"
|
|
},
|
|
"uniqueId" : {
|
|
"type" : "string"
|
|
},
|
|
"name" : {
|
|
"type" : "string"
|
|
},
|
|
"title" : {
|
|
"$ref" : "#/components/schemas/LocalizedString"
|
|
},
|
|
"description" : {
|
|
"$ref" : "#/components/schemas/LocalizedString"
|
|
},
|
|
"enabled" : {
|
|
"type" : "boolean"
|
|
},
|
|
"visible" : {
|
|
"type" : "boolean"
|
|
},
|
|
"abstractCategory" : {
|
|
"type" : "boolean"
|
|
},
|
|
"parentCategory" : {
|
|
"$ref" : "#/components/schemas/AssociatedCategoryData"
|
|
},
|
|
"categoryOrder" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
}
|
|
},
|
|
"LocalizedString" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"values" : {
|
|
"type" : "object",
|
|
"additionalProperties" : {
|
|
"type" : "string"
|
|
},
|
|
"xml" : {
|
|
"namespace" : "http://l10n.libreccm.org"
|
|
}
|
|
},
|
|
"value" : {
|
|
"type" : "string"
|
|
}
|
|
},
|
|
"xml" : {
|
|
"name" : "localized-string",
|
|
"namespace" : "http://l10n.libreccm.org"
|
|
}
|
|
},
|
|
"ListViewCategoryData" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"list" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/CategoryData"
|
|
}
|
|
},
|
|
"count" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"limit" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"offset" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
}
|
|
},
|
|
"CategorizationData" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"categorizationId" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"uuid" : {
|
|
"type" : "string"
|
|
},
|
|
"categorizedObject" : {
|
|
"$ref" : "#/components/schemas/CcmObjectId"
|
|
},
|
|
"indexObject" : {
|
|
"type" : "boolean"
|
|
},
|
|
"categoryOrder" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"objectOrder" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"type" : {
|
|
"type" : "string"
|
|
}
|
|
}
|
|
},
|
|
"CcmObjectId" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"objectId" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"uuid" : {
|
|
"type" : "string"
|
|
},
|
|
"displayName" : {
|
|
"type" : "string"
|
|
}
|
|
}
|
|
},
|
|
"ListViewCategorizationData" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"list" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/CategorizationData"
|
|
}
|
|
},
|
|
"count" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"limit" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"offset" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
}
|
|
},
|
|
"CategoryId" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"categoryId" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"uuid" : {
|
|
"type" : "string"
|
|
},
|
|
"uniqueId" : {
|
|
"type" : "string"
|
|
},
|
|
"name" : {
|
|
"type" : "string"
|
|
}
|
|
}
|
|
},
|
|
"CcmApplicationId" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"objectId" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"uuid" : {
|
|
"type" : "string"
|
|
},
|
|
"displayName" : {
|
|
"type" : "string"
|
|
},
|
|
"applicationType" : {
|
|
"type" : "string"
|
|
},
|
|
"primaryUrl" : {
|
|
"type" : "string"
|
|
}
|
|
}
|
|
},
|
|
"DomainData" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"domainId" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"uuid" : {
|
|
"type" : "string"
|
|
},
|
|
"domainKey" : {
|
|
"type" : "string"
|
|
},
|
|
"uri" : {
|
|
"type" : "string"
|
|
},
|
|
"title" : {
|
|
"$ref" : "#/components/schemas/LocalizedString"
|
|
},
|
|
"description" : {
|
|
"$ref" : "#/components/schemas/LocalizedString"
|
|
},
|
|
"version" : {
|
|
"type" : "string"
|
|
},
|
|
"released" : {
|
|
"type" : "string"
|
|
},
|
|
"root" : {
|
|
"$ref" : "#/components/schemas/CategoryId"
|
|
},
|
|
"owners" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/DomainOwnershipData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"DomainOwnershipData" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"ownershipId" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"uuid" : {
|
|
"type" : "string"
|
|
},
|
|
"context" : {
|
|
"type" : "string"
|
|
},
|
|
"owner" : {
|
|
"$ref" : "#/components/schemas/CcmApplicationId"
|
|
},
|
|
"ownerOrder" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
}
|
|
},
|
|
"ListViewDomainData" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"list" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/DomainData"
|
|
}
|
|
},
|
|
"count" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"limit" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"offset" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
}
|
|
},
|
|
"ListViewDomainOwnershipData" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"list" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/DomainOwnershipData"
|
|
}
|
|
},
|
|
"count" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"limit" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"offset" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
}
|
|
},
|
|
"ConfigurationInfo" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"name" : {
|
|
"type" : "string"
|
|
},
|
|
"descBundle" : {
|
|
"type" : "string"
|
|
},
|
|
"titleKey" : {
|
|
"type" : "string"
|
|
},
|
|
"descKey" : {
|
|
"type" : "string"
|
|
},
|
|
"settings" : {
|
|
"type" : "object",
|
|
"additionalProperties" : {
|
|
"$ref" : "#/components/schemas/SettingInfo"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"SettingInfo" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"name" : {
|
|
"type" : "string"
|
|
},
|
|
"valueType" : {
|
|
"type" : "string"
|
|
},
|
|
"defaultValue" : {
|
|
"type" : "string"
|
|
},
|
|
"confClass" : {
|
|
"type" : "string"
|
|
},
|
|
"descBundle" : {
|
|
"type" : "string"
|
|
},
|
|
"labelKey" : {
|
|
"type" : "string"
|
|
},
|
|
"descKey" : {
|
|
"type" : "string"
|
|
}
|
|
}
|
|
},
|
|
"GroupData" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"partyId" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"uuid" : {
|
|
"type" : "string"
|
|
},
|
|
"name" : {
|
|
"type" : "string"
|
|
},
|
|
"memberships" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/GroupUserMembership"
|
|
}
|
|
},
|
|
"roleMemberships" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/PartyRoleMembership"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GroupUserMembership" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"membershipId" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"uuid" : {
|
|
"type" : "string"
|
|
},
|
|
"user" : {
|
|
"$ref" : "#/components/schemas/PartyId"
|
|
}
|
|
}
|
|
},
|
|
"PartyId" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"partyId" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"uuid" : {
|
|
"type" : "string"
|
|
},
|
|
"name" : {
|
|
"type" : "string"
|
|
}
|
|
}
|
|
},
|
|
"PartyRoleMembership" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"membershipId" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"uuid" : {
|
|
"type" : "string"
|
|
},
|
|
"role" : {
|
|
"$ref" : "#/components/schemas/RoleId"
|
|
}
|
|
}
|
|
},
|
|
"RoleId" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"roleId" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"uuid" : {
|
|
"type" : "string"
|
|
},
|
|
"name" : {
|
|
"type" : "string"
|
|
}
|
|
}
|
|
},
|
|
"ListViewGroupData" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"list" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/GroupData"
|
|
}
|
|
},
|
|
"count" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"limit" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"offset" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
}
|
|
},
|
|
"ListViewGroupUserMembership" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"list" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/GroupUserMembership"
|
|
}
|
|
},
|
|
"count" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"limit" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"offset" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
}
|
|
},
|
|
"RoleData" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"roleId" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"uuid" : {
|
|
"type" : "string"
|
|
},
|
|
"name" : {
|
|
"type" : "string"
|
|
},
|
|
"description" : {
|
|
"$ref" : "#/components/schemas/LocalizedString"
|
|
},
|
|
"permissions" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/RolePermission"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"RolePermission" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"permissionId" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"uuid" : {
|
|
"type" : "string"
|
|
},
|
|
"grantedPrivilege" : {
|
|
"type" : "string"
|
|
},
|
|
"inherited" : {
|
|
"type" : "boolean"
|
|
},
|
|
"object" : {
|
|
"$ref" : "#/components/schemas/CcmObjectId"
|
|
},
|
|
"creationUser" : {
|
|
"$ref" : "#/components/schemas/PartyId"
|
|
},
|
|
"creationDate" : {
|
|
"type" : "string",
|
|
"format" : "date-time"
|
|
},
|
|
"creationIp" : {
|
|
"type" : "string"
|
|
},
|
|
"inheritedFrom" : {
|
|
"$ref" : "#/components/schemas/CcmObjectId"
|
|
}
|
|
}
|
|
},
|
|
"ListViewRoleData" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"list" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/RoleData"
|
|
}
|
|
},
|
|
"count" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"limit" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"offset" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
}
|
|
},
|
|
"ListViewRolePermission" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"list" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/RolePermission"
|
|
}
|
|
},
|
|
"count" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"limit" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"offset" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
}
|
|
},
|
|
"ListViewRolePartyMembership" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"list" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/RolePartyMembership"
|
|
}
|
|
},
|
|
"count" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"limit" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"offset" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
}
|
|
},
|
|
"RolePartyMembership" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"membershipId" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"uuid" : {
|
|
"type" : "string"
|
|
},
|
|
"party" : {
|
|
"$ref" : "#/components/schemas/PartyId"
|
|
}
|
|
}
|
|
},
|
|
"EmailAddressData" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"address" : {
|
|
"type" : "string"
|
|
},
|
|
"bouncing" : {
|
|
"type" : "boolean"
|
|
},
|
|
"verified" : {
|
|
"type" : "boolean"
|
|
}
|
|
}
|
|
},
|
|
"UserData" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"partyId" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"uuid" : {
|
|
"type" : "string"
|
|
},
|
|
"name" : {
|
|
"type" : "string"
|
|
},
|
|
"givenName" : {
|
|
"type" : "string"
|
|
},
|
|
"familyName" : {
|
|
"type" : "string"
|
|
},
|
|
"primaryEmailAddress" : {
|
|
"$ref" : "#/components/schemas/EmailAddressData"
|
|
},
|
|
"emailAddresses" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/EmailAddressData"
|
|
}
|
|
},
|
|
"banned" : {
|
|
"type" : "boolean"
|
|
},
|
|
"passwordResetRequired" : {
|
|
"type" : "boolean"
|
|
},
|
|
"groupMemberships" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/UserGroupMembership"
|
|
}
|
|
},
|
|
"roleMemberships" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/PartyRoleMembership"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"UserGroupMembership" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"membershipId" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"uuid" : {
|
|
"type" : "string"
|
|
},
|
|
"group" : {
|
|
"$ref" : "#/components/schemas/PartyId"
|
|
}
|
|
}
|
|
},
|
|
"EmailAddress" : {
|
|
"required" : [ "address" ],
|
|
"type" : "object",
|
|
"properties" : {
|
|
"address" : {
|
|
"type" : "string",
|
|
"xml" : {
|
|
"namespace" : "http://core.libreccm.org"
|
|
}
|
|
},
|
|
"bouncing" : {
|
|
"type" : "boolean",
|
|
"xml" : {
|
|
"namespace" : "http://core.libreccm.org"
|
|
}
|
|
},
|
|
"verified" : {
|
|
"type" : "boolean",
|
|
"xml" : {
|
|
"namespace" : "http://core.libreccm.org"
|
|
}
|
|
}
|
|
},
|
|
"xml" : {
|
|
"name" : "email-address",
|
|
"namespace" : "http://core.libreccm.org"
|
|
}
|
|
},
|
|
"User" : {
|
|
"required" : [ "name", "primaryEmailAddress" ],
|
|
"type" : "object",
|
|
"properties" : {
|
|
"partyId" : {
|
|
"type" : "integer",
|
|
"format" : "int64",
|
|
"xml" : {
|
|
"name" : "party-id",
|
|
"namespace" : "http://core.libreccm.org"
|
|
}
|
|
},
|
|
"uuid" : {
|
|
"type" : "string",
|
|
"xml" : {
|
|
"namespace" : "http://core.libreccm.org"
|
|
}
|
|
},
|
|
"name" : {
|
|
"type" : "string",
|
|
"xml" : {
|
|
"namespace" : "http://core.libreccm.org"
|
|
}
|
|
},
|
|
"givenName" : {
|
|
"type" : "string",
|
|
"xml" : {
|
|
"name" : "given-name",
|
|
"namespace" : "http://core.libreccm.org"
|
|
}
|
|
},
|
|
"familyName" : {
|
|
"type" : "string",
|
|
"xml" : {
|
|
"name" : "family-name",
|
|
"namespace" : "http://core.libreccm.org"
|
|
}
|
|
},
|
|
"primaryEmailAddress" : {
|
|
"$ref" : "#/components/schemas/EmailAddress"
|
|
},
|
|
"emailAddresses" : {
|
|
"type" : "array",
|
|
"xml" : {
|
|
"name" : "email-addresses",
|
|
"wrapped" : true
|
|
},
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/EmailAddress"
|
|
}
|
|
},
|
|
"banned" : {
|
|
"type" : "boolean",
|
|
"xml" : {
|
|
"namespace" : "http://core.libreccm.org"
|
|
}
|
|
},
|
|
"password" : {
|
|
"type" : "string"
|
|
},
|
|
"passwordResetRequired" : {
|
|
"type" : "boolean"
|
|
}
|
|
},
|
|
"xml" : {
|
|
"name" : "user",
|
|
"namespace" : "http://core.libreccm.org"
|
|
}
|
|
},
|
|
"ListViewUserData" : {
|
|
"type" : "object",
|
|
"properties" : {
|
|
"list" : {
|
|
"type" : "array",
|
|
"items" : {
|
|
"$ref" : "#/components/schemas/UserData"
|
|
}
|
|
},
|
|
"count" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"limit" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
},
|
|
"offset" : {
|
|
"type" : "integer",
|
|
"format" : "int64"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} |