2023-05-24 10:34:27 -04:00
{
"openapi" : "3.0.3" ,
"info" : {
"title" : "provisioning_api" ,
"version" : "0.0.1" ,
2024-02-13 04:22:58 -05:00
"description" : "This application enables a set of APIs that external systems can use to manage accounts, groups and apps." ,
2023-05-24 10:34:27 -04:00
"license" : {
"name" : "agpl"
}
} ,
"components" : {
"securitySchemes" : {
"basic_auth" : {
"type" : "http" ,
"scheme" : "basic"
} ,
"bearer_auth" : {
"type" : "http" ,
"scheme" : "bearer"
}
} ,
"schemas" : {
"Capabilities" : {
"type" : "object" ,
"required" : [
"provisioning_api"
] ,
"properties" : {
"provisioning_api" : {
"type" : "object" ,
"required" : [
"version" ,
"AccountPropertyScopesVersion" ,
"AccountPropertyScopesFederatedEnabled" ,
"AccountPropertyScopesPublishedEnabled"
] ,
"properties" : {
"version" : {
"type" : "string"
} ,
"AccountPropertyScopesVersion" : {
"type" : "integer" ,
"format" : "int64"
} ,
"AccountPropertyScopesFederatedEnabled" : {
"type" : "boolean"
} ,
"AccountPropertyScopesPublishedEnabled" : {
"type" : "boolean"
}
}
}
}
} ,
"GroupDetails" : {
"type" : "object" ,
"required" : [
"id" ,
"displayname" ,
"usercount" ,
"disabled" ,
"canAdd" ,
"canRemove"
] ,
"properties" : {
"id" : {
"type" : "string"
} ,
"displayname" : {
"type" : "string"
} ,
"usercount" : {
"oneOf" : [
{
"type" : "boolean"
} ,
{
"type" : "integer" ,
"format" : "int64"
}
]
} ,
"disabled" : {
"oneOf" : [
{
"type" : "boolean"
} ,
{
"type" : "integer" ,
"format" : "int64"
}
]
} ,
"canAdd" : {
"type" : "boolean"
} ,
"canRemove" : {
"type" : "boolean"
}
}
} ,
"OCSMeta" : {
"type" : "object" ,
"required" : [
"status" ,
"statuscode"
] ,
"properties" : {
"status" : {
"type" : "string"
} ,
"statuscode" : {
"type" : "integer"
} ,
"message" : {
"type" : "string"
} ,
"totalitems" : {
"type" : "string"
} ,
"itemsperpage" : {
"type" : "string"
}
}
} ,
"UserDetails" : {
"type" : "object" ,
"required" : [
"additional_mail" ,
"address" ,
"backend" ,
"backendCapabilities" ,
"biography" ,
"display-name" ,
2023-02-15 13:27:04 -05:00
"displayname" ,
2023-05-24 10:34:27 -04:00
"email" ,
"fediverse" ,
"groups" ,
"headline" ,
"id" ,
"language" ,
2024-12-10 06:20:24 -05:00
"firstLoginTimestamp" ,
"lastLoginTimestamp" ,
2023-05-24 10:34:27 -04:00
"lastLogin" ,
"locale" ,
2023-02-15 13:27:04 -05:00
"manager" ,
2023-05-24 10:34:27 -04:00
"notify_email" ,
"organisation" ,
"phone" ,
"profile_enabled" ,
2024-09-17 15:41:45 -04:00
"pronouns" ,
2023-05-24 10:34:27 -04:00
"quota" ,
"role" ,
"subadmin" ,
2025-08-18 06:46:00 -04:00
"timezone" ,
2023-05-24 10:34:27 -04:00
"twitter" ,
2025-08-06 12:35:46 -04:00
"bluesky" ,
2023-02-15 13:27:04 -05:00
"website"
2023-05-24 10:34:27 -04:00
] ,
"properties" : {
"additional_mail" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"additional_mailScope" : {
"type" : "array" ,
"items" : {
2024-05-11 03:22:19 -04:00
"$ref" : "#/components/schemas/UserDetailsScope"
2023-05-24 10:34:27 -04:00
}
} ,
"address" : {
"type" : "string"
} ,
"addressScope" : {
2024-05-11 03:22:19 -04:00
"$ref" : "#/components/schemas/UserDetailsScope"
2023-05-24 10:34:27 -04:00
} ,
"avatarScope" : {
2024-05-11 03:22:19 -04:00
"$ref" : "#/components/schemas/UserDetailsScope"
2023-05-24 10:34:27 -04:00
} ,
"backend" : {
"type" : "string"
} ,
"backendCapabilities" : {
"type" : "object" ,
"required" : [
"setDisplayName" ,
"setPassword"
] ,
"properties" : {
"setDisplayName" : {
"type" : "boolean"
} ,
"setPassword" : {
"type" : "boolean"
}
}
} ,
"biography" : {
"type" : "string"
} ,
"biographyScope" : {
2024-05-11 03:22:19 -04:00
"$ref" : "#/components/schemas/UserDetailsScope"
2023-05-24 10:34:27 -04:00
} ,
"display-name" : {
"type" : "string"
} ,
2023-02-15 13:27:04 -05:00
"displayname" : {
"type" : "string"
} ,
2023-05-24 10:34:27 -04:00
"displaynameScope" : {
2024-05-11 03:22:19 -04:00
"$ref" : "#/components/schemas/UserDetailsScope"
2023-05-24 10:34:27 -04:00
} ,
"email" : {
"type" : "string" ,
"nullable" : true
} ,
"emailScope" : {
2024-05-11 03:22:19 -04:00
"$ref" : "#/components/schemas/UserDetailsScope"
2023-05-24 10:34:27 -04:00
} ,
"enabled" : {
2023-02-15 13:27:04 -05:00
"type" : "boolean"
2023-05-24 10:34:27 -04:00
} ,
"fediverse" : {
2023-02-15 13:27:04 -05:00
"type" : "string"
2023-05-24 10:34:27 -04:00
} ,
"fediverseScope" : {
2024-05-11 03:22:19 -04:00
"$ref" : "#/components/schemas/UserDetailsScope"
2023-05-24 10:34:27 -04:00
} ,
"groups" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"headline" : {
"type" : "string"
} ,
"headlineScope" : {
2024-05-11 03:22:19 -04:00
"$ref" : "#/components/schemas/UserDetailsScope"
2023-05-24 10:34:27 -04:00
} ,
"id" : {
"type" : "string"
} ,
"language" : {
"type" : "string"
} ,
2024-12-10 06:20:24 -05:00
"firstLoginTimestamp" : {
"type" : "integer" ,
"format" : "int64"
} ,
"lastLoginTimestamp" : {
2024-11-19 09:23:29 -05:00
"type" : "integer" ,
"format" : "int64"
} ,
2023-05-24 10:34:27 -04:00
"lastLogin" : {
"type" : "integer" ,
"format" : "int64"
} ,
"locale" : {
"type" : "string"
} ,
2023-02-15 13:27:04 -05:00
"manager" : {
"type" : "string"
} ,
2023-05-24 10:34:27 -04:00
"notify_email" : {
"type" : "string" ,
"nullable" : true
} ,
"organisation" : {
"type" : "string"
} ,
"organisationScope" : {
2024-05-11 03:22:19 -04:00
"$ref" : "#/components/schemas/UserDetailsScope"
2023-05-24 10:34:27 -04:00
} ,
"phone" : {
"type" : "string"
} ,
"phoneScope" : {
2024-05-11 03:22:19 -04:00
"$ref" : "#/components/schemas/UserDetailsScope"
2023-05-24 10:34:27 -04:00
} ,
"profile_enabled" : {
"type" : "string"
} ,
"profile_enabledScope" : {
2024-05-11 03:22:19 -04:00
"$ref" : "#/components/schemas/UserDetailsScope"
2023-05-24 10:34:27 -04:00
} ,
2024-09-17 15:41:45 -04:00
"pronouns" : {
"type" : "string"
} ,
"pronounsScope" : {
"$ref" : "#/components/schemas/UserDetailsScope"
} ,
2023-05-24 10:34:27 -04:00
"quota" : {
2023-02-15 13:27:04 -05:00
"$ref" : "#/components/schemas/UserDetailsQuota"
2023-05-24 10:34:27 -04:00
} ,
"role" : {
"type" : "string"
} ,
"roleScope" : {
2024-05-11 03:22:19 -04:00
"$ref" : "#/components/schemas/UserDetailsScope"
2023-05-24 10:34:27 -04:00
} ,
"storageLocation" : {
2023-02-15 13:27:04 -05:00
"type" : "string"
2023-05-24 10:34:27 -04:00
} ,
"subadmin" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
2025-08-18 06:46:00 -04:00
"timezone" : {
"type" : "string"
} ,
2023-05-24 10:34:27 -04:00
"twitter" : {
"type" : "string"
} ,
"twitterScope" : {
2024-05-11 03:22:19 -04:00
"$ref" : "#/components/schemas/UserDetailsScope"
2023-05-24 10:34:27 -04:00
} ,
2025-08-06 12:35:46 -04:00
"bluesky" : {
"type" : "string"
} ,
"blueskyScope" : {
"$ref" : "#/components/schemas/UserDetailsScope"
} ,
2023-05-24 10:34:27 -04:00
"website" : {
"type" : "string"
} ,
"websiteScope" : {
2024-05-11 03:22:19 -04:00
"$ref" : "#/components/schemas/UserDetailsScope"
2023-02-15 13:27:04 -05:00
}
}
} ,
"UserDetailsQuota" : {
"type" : "object" ,
"properties" : {
"free" : {
2024-04-15 03:10:59 -04:00
"anyOf" : [
2023-10-22 07:28:39 -04:00
{
"type" : "number" ,
2024-04-15 03:10:59 -04:00
"format" : "double"
2023-10-22 07:28:39 -04:00
} ,
{
"type" : "integer" ,
"format" : "int64"
}
]
2023-02-15 13:27:04 -05:00
} ,
"quota" : {
2024-04-15 03:10:59 -04:00
"anyOf" : [
2023-02-15 13:27:04 -05:00
{
"type" : "number" ,
2024-04-15 03:10:59 -04:00
"format" : "double"
2023-02-15 13:27:04 -05:00
} ,
2023-09-14 09:41:10 -04:00
{
"type" : "integer" ,
"format" : "int64"
} ,
2023-02-15 13:27:04 -05:00
{
"type" : "string"
}
]
} ,
"relative" : {
2024-04-15 03:10:59 -04:00
"anyOf" : [
2023-10-22 07:28:39 -04:00
{
"type" : "number" ,
2024-04-15 03:10:59 -04:00
"format" : "double"
2023-10-22 07:28:39 -04:00
} ,
{
"type" : "integer" ,
"format" : "int64"
}
]
2023-02-15 13:27:04 -05:00
} ,
"total" : {
2024-04-15 03:10:59 -04:00
"anyOf" : [
2023-10-22 07:28:39 -04:00
{
"type" : "number" ,
2024-04-15 03:10:59 -04:00
"format" : "double"
2023-10-22 07:28:39 -04:00
} ,
{
"type" : "integer" ,
"format" : "int64"
}
]
2023-02-15 13:27:04 -05:00
} ,
"used" : {
2024-04-15 03:10:59 -04:00
"anyOf" : [
2023-10-22 07:28:39 -04:00
{
"type" : "number" ,
2024-04-15 03:10:59 -04:00
"format" : "double"
2023-10-22 07:28:39 -04:00
} ,
{
"type" : "integer" ,
"format" : "int64"
}
]
2023-05-24 10:34:27 -04:00
}
}
2024-05-11 03:22:19 -04:00
} ,
"UserDetailsScope" : {
"type" : "string" ,
"enum" : [
"v2-private" ,
"v2-local" ,
"v2-federated" ,
2025-08-28 06:19:01 -04:00
"v2-published"
2024-05-11 03:22:19 -04:00
]
2023-05-24 10:34:27 -04:00
}
}
} ,
"paths" : {
2024-01-18 09:56:09 -05:00
"/ocs/v2.php/cloud/groups" : {
2023-05-24 10:34:27 -04:00
"get" : {
2024-01-18 09:56:09 -05:00
"operationId" : "groups-get-groups" ,
"summary" : "Get a list of groups" ,
2023-05-24 10:34:27 -04:00
"tags" : [
2024-01-18 09:56:09 -05:00
"groups"
2023-05-24 10:34:27 -04:00
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
2024-07-02 03:08:04 -04:00
"parameters" : [
2024-08-19 05:08:28 -04:00
{
"name" : "search" ,
"in" : "query" ,
"description" : "Text to search for" ,
"schema" : {
"type" : "string" ,
"default" : ""
}
} ,
{
"name" : "limit" ,
"in" : "query" ,
"description" : "Limit the amount of groups returned" ,
"schema" : {
"type" : "integer" ,
"format" : "int64" ,
2025-06-01 07:39:11 -04:00
"nullable" : true ,
"default" : null
2024-08-19 05:08:28 -04:00
}
} ,
{
"name" : "offset" ,
"in" : "query" ,
"description" : "Offset for searching for groups" ,
"schema" : {
"type" : "integer" ,
"format" : "int64" ,
"default" : 0
}
} ,
2023-05-24 10:34:27 -04:00
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "Groups returned" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : {
"type" : "object" ,
"required" : [
2024-01-18 09:56:09 -05:00
"groups"
2023-05-24 10:34:27 -04:00
] ,
"properties" : {
2024-01-18 09:56:09 -05:00
"groups" : {
2023-05-24 10:34:27 -04:00
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
}
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
}
} ,
2024-01-18 09:56:09 -05:00
"/ocs/v2.php/cloud/groups/details" : {
2023-05-24 10:34:27 -04:00
"get" : {
2024-01-18 09:56:09 -05:00
"operationId" : "groups-get-groups-details" ,
"summary" : "Get a list of groups details" ,
2023-05-24 10:34:27 -04:00
"tags" : [
2024-01-18 09:56:09 -05:00
"groups"
2023-05-24 10:34:27 -04:00
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
2024-07-02 03:08:04 -04:00
"parameters" : [
2024-08-19 05:08:28 -04:00
{
"name" : "search" ,
"in" : "query" ,
"description" : "Text to search for" ,
"schema" : {
"type" : "string" ,
"default" : ""
}
} ,
{
"name" : "limit" ,
"in" : "query" ,
"description" : "Limit the amount of groups returned" ,
"schema" : {
"type" : "integer" ,
"format" : "int64" ,
2025-06-01 07:39:11 -04:00
"nullable" : true ,
"default" : null
2024-08-19 05:08:28 -04:00
}
} ,
{
"name" : "offset" ,
"in" : "query" ,
"description" : "Offset for searching for groups" ,
"schema" : {
"type" : "integer" ,
"format" : "int64" ,
"default" : 0
}
} ,
2023-05-24 10:34:27 -04:00
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "Groups details returned" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : {
2024-01-18 09:56:09 -05:00
"type" : "object" ,
"required" : [
"groups"
] ,
"properties" : {
"groups" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/GroupDetails"
}
}
}
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
2024-01-18 09:56:09 -05:00
}
} ,
"/ocs/v2.php/cloud/groups/{groupId}/users" : {
"get" : {
"operationId" : "groups-get-group-users" ,
"summary" : "Get a list of users in the specified group" ,
2023-05-24 10:34:27 -04:00
"tags" : [
2024-01-18 09:56:09 -05:00
"groups"
2023-05-24 10:34:27 -04:00
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
"parameters" : [
{
2024-01-18 09:56:09 -05:00
"name" : "groupId" ,
2023-05-24 10:34:27 -04:00
"in" : "path" ,
2024-01-18 09:56:09 -05:00
"description" : "ID of the group" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2024-01-18 09:56:09 -05:00
"type" : "string" ,
"pattern" : "^.+$"
2023-05-24 10:34:27 -04:00
}
} ,
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "User IDs returned" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2024-01-18 09:56:09 -05:00
"data" : {
"type" : "object" ,
"required" : [
"users"
] ,
"properties" : {
"users" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
2024-01-18 09:56:09 -05:00
} ,
"404" : {
"description" : "Group not found" ,
"content" : {
2024-04-08 14:09:24 -04:00
"application/json" : {
2024-01-18 09:56:09 -05:00
"schema" : {
2024-04-08 14:09:24 -04:00
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
2024-01-18 09:56:09 -05:00
}
}
}
} ,
"403" : {
"description" : "Missing permissions to get users in the group" ,
"content" : {
2024-04-08 14:09:24 -04:00
"application/json" : {
2024-01-18 09:56:09 -05:00
"schema" : {
2024-04-08 14:09:24 -04:00
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
2024-01-18 09:56:09 -05:00
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
2024-01-18 09:56:09 -05:00
}
} ,
"/ocs/v2.php/cloud/groups/{groupId}/users/details" : {
"get" : {
"operationId" : "groups-get-group-users-details" ,
"summary" : "Get a list of users details in the specified group" ,
2023-05-24 10:34:27 -04:00
"tags" : [
"groups"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
2024-07-02 03:08:04 -04:00
"parameters" : [
2024-01-18 09:56:09 -05:00
{
"name" : "groupId" ,
"in" : "path" ,
"description" : "ID of the group" ,
"required" : true ,
"schema" : {
"type" : "string" ,
"pattern" : "^.+$"
}
} ,
2024-08-19 05:08:28 -04:00
{
"name" : "search" ,
"in" : "query" ,
"description" : "Text to search for" ,
"schema" : {
"type" : "string" ,
"default" : ""
}
} ,
{
"name" : "limit" ,
"in" : "query" ,
"description" : "Limit the amount of groups returned" ,
"schema" : {
"type" : "integer" ,
"format" : "int64" ,
2025-06-01 07:39:11 -04:00
"nullable" : true ,
"default" : null
2024-08-19 05:08:28 -04:00
}
} ,
{
"name" : "offset" ,
"in" : "query" ,
"description" : "Offset for searching for groups" ,
"schema" : {
"type" : "integer" ,
"format" : "int64" ,
"default" : 0
}
} ,
2023-05-24 10:34:27 -04:00
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "Group users details returned" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : {
"type" : "object" ,
"required" : [
2024-01-18 09:56:09 -05:00
"users"
2023-05-24 10:34:27 -04:00
] ,
"properties" : {
2024-01-18 09:56:09 -05:00
"users" : {
"type" : "object" ,
"additionalProperties" : {
2024-04-15 03:10:59 -04:00
"anyOf" : [
2024-01-18 09:56:09 -05:00
{
"$ref" : "#/components/schemas/UserDetails"
} ,
{
"type" : "object" ,
"required" : [
"id"
] ,
"properties" : {
"id" : {
"type" : "string"
}
}
}
]
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
2024-01-18 09:56:09 -05:00
}
} ,
"/ocs/v2.php/cloud/groups/{groupId}" : {
"get" : {
"operationId" : "groups-get-group" ,
"summary" : "Get a list of users in the specified group" ,
"deprecated" : true ,
2023-05-24 10:34:27 -04:00
"tags" : [
"groups"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
"parameters" : [
{
2024-01-18 09:56:09 -05:00
"name" : "groupId" ,
"in" : "path" ,
2023-05-24 10:34:27 -04:00
"description" : "ID of the group" ,
"required" : true ,
"schema" : {
"type" : "string" ,
2024-01-18 09:56:09 -05:00
"pattern" : "^.+$"
2023-05-24 10:34:27 -04:00
}
} ,
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "Group users returned" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2024-01-18 09:56:09 -05:00
"data" : {
"type" : "object" ,
"required" : [
"users"
] ,
"properties" : {
"users" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
}
} ,
2024-01-18 09:56:09 -05:00
"/ocs/v2.php/cloud/users" : {
2023-05-24 10:34:27 -04:00
"get" : {
2024-01-18 09:56:09 -05:00
"operationId" : "users-get-users" ,
"summary" : "Get a list of users" ,
2023-05-24 10:34:27 -04:00
"tags" : [
2024-01-18 09:56:09 -05:00
"users"
2023-05-24 10:34:27 -04:00
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
2024-07-02 03:08:04 -04:00
"parameters" : [
2024-08-19 05:08:28 -04:00
{
"name" : "search" ,
"in" : "query" ,
"description" : "Text to search for" ,
"schema" : {
"type" : "string" ,
"default" : ""
}
} ,
{
"name" : "limit" ,
"in" : "query" ,
"description" : "Limit the amount of groups returned" ,
"schema" : {
"type" : "integer" ,
"format" : "int64" ,
2025-06-01 07:39:11 -04:00
"nullable" : true ,
"default" : null
2024-08-19 05:08:28 -04:00
}
} ,
{
"name" : "offset" ,
"in" : "query" ,
"description" : "Offset for searching for groups" ,
"schema" : {
"type" : "integer" ,
"format" : "int64" ,
"default" : 0
}
} ,
2023-05-24 10:34:27 -04:00
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "Users returned" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : {
"type" : "object" ,
"required" : [
2024-01-18 09:56:09 -05:00
"users"
2023-05-24 10:34:27 -04:00
] ,
"properties" : {
2024-01-18 09:56:09 -05:00
"users" : {
2023-05-24 10:34:27 -04:00
"type" : "array" ,
"items" : {
2024-01-18 09:56:09 -05:00
"type" : "string"
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
2024-01-18 09:56:09 -05:00
} ,
"post" : {
"operationId" : "users-add-user" ,
"summary" : "Create a new user" ,
2024-04-15 03:10:59 -04:00
"description" : "This endpoint requires password confirmation" ,
2023-05-24 10:34:27 -04:00
"tags" : [
2024-01-18 09:56:09 -05:00
"users"
2023-05-24 10:34:27 -04:00
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
2024-07-02 03:08:04 -04:00
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"userid"
] ,
"properties" : {
"userid" : {
"type" : "string" ,
"description" : "ID of the user"
} ,
"password" : {
"type" : "string" ,
"default" : "" ,
"description" : "Password of the user"
} ,
"displayName" : {
"type" : "string" ,
"default" : "" ,
"description" : "Display name of the user"
} ,
"email" : {
"type" : "string" ,
"default" : "" ,
"description" : "Email of the user"
} ,
"groups" : {
"type" : "array" ,
"default" : [ ] ,
"description" : "Groups of the user" ,
"items" : {
"type" : "string"
}
} ,
"subadmin" : {
"type" : "array" ,
"default" : [ ] ,
"description" : "Groups where the user is subadmin" ,
"items" : {
"type" : "string"
}
} ,
"quota" : {
"type" : "string" ,
"default" : "" ,
"description" : "Quota of the user"
} ,
"language" : {
"type" : "string" ,
"default" : "" ,
"description" : "Language of the user"
} ,
"manager" : {
"type" : "string" ,
"nullable" : true ,
2025-06-01 07:39:11 -04:00
"default" : null ,
2024-07-02 03:08:04 -04:00
"description" : "Manager of the user"
}
}
2024-01-18 09:56:09 -05:00
}
}
2024-07-02 03:08:04 -04:00
}
} ,
"parameters" : [
2023-05-24 10:34:27 -04:00
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "User added successfully" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : {
"type" : "object" ,
"required" : [
2024-01-18 09:56:09 -05:00
"id"
2023-05-24 10:34:27 -04:00
] ,
"properties" : {
2024-01-18 09:56:09 -05:00
"id" : {
"type" : "string"
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
}
}
}
} ,
"403" : {
2024-01-18 09:56:09 -05:00
"description" : "Missing permissions to make user subadmin" ,
2023-05-24 10:34:27 -04:00
"content" : {
2024-04-08 14:09:24 -04:00
"application/json" : {
2023-05-24 10:34:27 -04:00
"schema" : {
2024-04-08 14:09:24 -04:00
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
2023-05-24 10:34:27 -04:00
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
}
} ,
2024-01-18 09:56:09 -05:00
"/ocs/v2.php/cloud/users/details" : {
2023-05-24 10:34:27 -04:00
"get" : {
2024-01-18 09:56:09 -05:00
"operationId" : "users-get-users-details" ,
"summary" : "Get a list of users and their details" ,
2023-05-24 10:34:27 -04:00
"tags" : [
2024-01-18 09:56:09 -05:00
"users"
2023-05-24 10:34:27 -04:00
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
2024-07-02 03:08:04 -04:00
"parameters" : [
2024-08-19 05:08:28 -04:00
{
"name" : "search" ,
"in" : "query" ,
"description" : "Text to search for" ,
"schema" : {
"type" : "string" ,
"default" : ""
}
} ,
{
"name" : "limit" ,
"in" : "query" ,
"description" : "Limit the amount of groups returned" ,
"schema" : {
"type" : "integer" ,
"format" : "int64" ,
2025-06-01 07:39:11 -04:00
"nullable" : true ,
"default" : null
2024-08-19 05:08:28 -04:00
}
} ,
{
"name" : "offset" ,
"in" : "query" ,
"description" : "Offset for searching for groups" ,
"schema" : {
"type" : "integer" ,
"format" : "int64" ,
"default" : 0
}
} ,
2023-05-24 10:34:27 -04:00
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "Users details returned" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : {
"type" : "object" ,
"required" : [
"users"
] ,
"properties" : {
"users" : {
"type" : "object" ,
"additionalProperties" : {
2024-04-15 03:10:59 -04:00
"anyOf" : [
2023-05-24 10:34:27 -04:00
{
"$ref" : "#/components/schemas/UserDetails"
} ,
{
"type" : "object" ,
"required" : [
"id"
] ,
"properties" : {
"id" : {
"type" : "string"
}
}
}
]
}
}
}
}
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
}
} ,
2024-01-18 09:56:09 -05:00
"/ocs/v2.php/cloud/users/disabled" : {
2023-05-24 10:34:27 -04:00
"get" : {
2024-01-18 09:56:09 -05:00
"operationId" : "users-get-disabled-users-details" ,
"summary" : "Get the list of disabled users and their details" ,
2023-05-24 10:34:27 -04:00
"tags" : [
2024-01-18 09:56:09 -05:00
"users"
2023-05-24 10:34:27 -04:00
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
2024-07-02 03:08:04 -04:00
"parameters" : [
2024-08-19 05:08:28 -04:00
{
"name" : "search" ,
"in" : "query" ,
"description" : "Text to search for" ,
"schema" : {
"type" : "string" ,
"default" : ""
}
} ,
{
"name" : "limit" ,
"in" : "query" ,
"description" : "Limit the amount of users returned" ,
"schema" : {
"type" : "integer" ,
"format" : "int64" ,
2025-06-01 07:39:11 -04:00
"nullable" : true ,
"default" : null
2024-08-19 05:08:28 -04:00
}
} ,
{
"name" : "offset" ,
"in" : "query" ,
"description" : "Offset" ,
"schema" : {
"type" : "integer" ,
"format" : "int64" ,
"default" : 0
}
} ,
2023-05-24 10:34:27 -04:00
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "Disabled users details returned" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : {
"type" : "object" ,
"required" : [
"users"
] ,
"properties" : {
"users" : {
2024-01-18 09:56:09 -05:00
"type" : "object" ,
"additionalProperties" : {
2024-04-15 03:10:59 -04:00
"anyOf" : [
2024-01-18 09:56:09 -05:00
{
"$ref" : "#/components/schemas/UserDetails"
} ,
{
"type" : "object" ,
"required" : [
"id"
] ,
"properties" : {
"id" : {
"type" : "string"
}
}
}
]
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
2024-01-18 09:56:09 -05:00
}
} ,
"/ocs/v2.php/cloud/users/search/by-phone" : {
"post" : {
"operationId" : "users-search-by-phone-numbers" ,
"summary" : "Search users by their phone numbers" ,
2023-05-24 10:34:27 -04:00
"tags" : [
2024-01-18 09:56:09 -05:00
"users"
2023-05-24 10:34:27 -04:00
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
2024-07-02 03:08:04 -04:00
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"location" ,
"search"
] ,
"properties" : {
"location" : {
"type" : "string" ,
"description" : "Location of the phone number (for country code)"
} ,
"search" : {
"type" : "object" ,
"description" : "Phone numbers to search for" ,
"additionalProperties" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
2024-07-02 03:08:04 -04:00
}
} ,
"parameters" : [
2023-05-24 10:34:27 -04:00
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "Users returned" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2024-01-18 09:56:09 -05:00
"data" : {
"type" : "object" ,
"additionalProperties" : {
"type" : "string"
}
}
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
} ,
2024-01-18 09:56:09 -05:00
"400" : {
"description" : "Invalid location" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2023-02-15 13:27:04 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
} ,
2025-08-26 04:21:10 -04:00
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
}
}
}
} ,
"/ocs/v2.php/cloud/users/{userId}" : {
"get" : {
"operationId" : "users-get-user" ,
"summary" : "Get the details of a user" ,
"tags" : [
"users"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
"parameters" : [
{
"name" : "userId" ,
"in" : "path" ,
2023-05-24 10:34:27 -04:00
"description" : "ID of the user" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "User returned" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2024-01-18 09:56:09 -05:00
"data" : {
"$ref" : "#/components/schemas/UserDetails"
}
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
2024-01-18 09:56:09 -05:00
} ,
2023-05-24 10:34:27 -04:00
"put" : {
2024-01-18 09:56:09 -05:00
"operationId" : "users-edit-user" ,
"summary" : "Update a value of the user's details" ,
2024-04-15 03:10:59 -04:00
"description" : "This endpoint requires password confirmation" ,
2023-05-24 10:34:27 -04:00
"tags" : [
"users"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
2024-07-02 03:08:04 -04:00
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"key" ,
"value"
] ,
"properties" : {
"key" : {
"type" : "string" ,
"description" : "Key that will be updated"
} ,
"value" : {
"type" : "string" ,
"description" : "New value for the key"
}
}
}
2024-01-18 09:56:09 -05:00
}
2024-07-02 03:08:04 -04:00
}
} ,
"parameters" : [
2023-05-24 10:34:27 -04:00
{
"name" : "userId" ,
"in" : "path" ,
"description" : "ID of the user" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "User value edited successfully" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2023-02-15 13:27:04 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
2026-04-21 08:13:45 -04:00
}
}
}
}
}
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
}
}
} ,
"patch" : {
"operationId" : "users-edit-user-multi-field" ,
"summary" : "Update multiple user account fields atomically. All submitted fields are validated first; if any fail, no changes are applied." ,
"description" : "Unlike editUser (which updates one field at a time via key/value), this method accepts named fields and applies them all in a single request.\nThis endpoint requires password confirmation" ,
"tags" : [
"users"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
"requestBody" : {
"required" : false ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"properties" : {
"displayName" : {
"type" : "string" ,
"nullable" : true ,
"default" : null ,
"description" : "New display name (null = no change)"
} ,
"password" : {
"type" : "string" ,
"nullable" : true ,
"default" : null ,
"description" : "New password (null = no change)"
} ,
"email" : {
"type" : "string" ,
"nullable" : true ,
"default" : null ,
"description" : "New primary email (null = no change, '' = clear)"
} ,
"quota" : {
"type" : "string" ,
"nullable" : true ,
"default" : null ,
"description" : "New quota e.g. \"5 GB\" (null = no change)"
} ,
"language" : {
"type" : "string" ,
"nullable" : true ,
"default" : null ,
"description" : "Language code e.g. \"de\" (null = no change)"
} ,
"manager" : {
"type" : "string" ,
"nullable" : true ,
"default" : null ,
"description" : "Manager user ID (null = no change, '' = clear)"
} ,
"groups" : {
"type" : "array" ,
"nullable" : true ,
"default" : null ,
"description" : "Group IDs to assign (null = no change, [] = remove all)" ,
"items" : {
"type" : "string"
}
} ,
"subadminGroups" : {
"type" : "array" ,
"nullable" : true ,
"default" : null ,
"description" : "Subadmin group IDs (null = no change, [] = remove all)" ,
"items" : {
"type" : "string"
}
}
}
}
}
}
} ,
"parameters" : [
{
"name" : "userId" ,
"in" : "path" ,
"description" : "The user to update" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
"description" : "Required to be true for the API request to pass" ,
"required" : true ,
"schema" : {
"type" : "boolean" ,
"default" : true
}
}
] ,
"responses" : {
"200" : {
"description" : "User updated successfully" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : {
"$ref" : "#/components/schemas/UserDetails"
}
}
}
}
}
}
}
} ,
"422" : {
"description" : "One or more submitted fields failed validation" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : {
"type" : "object" ,
"required" : [
"errors"
] ,
"properties" : {
"errors" : {
"type" : "object" ,
"additionalProperties" : {
"type" : "string"
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
2024-01-18 09:56:09 -05:00
} ,
"delete" : {
"operationId" : "users-delete-user" ,
"summary" : "Delete a user" ,
2024-04-15 03:10:59 -04:00
"description" : "This endpoint requires password confirmation" ,
2023-05-24 10:34:27 -04:00
"tags" : [
"users"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
"parameters" : [
{
"name" : "userId" ,
"in" : "path" ,
"description" : "ID of the user" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "User deleted successfully" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2024-01-18 09:56:09 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
2024-01-18 09:56:09 -05:00
}
} ,
"/ocs/v2.php/cloud/user" : {
"get" : {
"operationId" : "users-get-current-user" ,
"summary" : "Get the details of the current user" ,
2023-05-24 10:34:27 -04:00
"tags" : [
"users"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
"parameters" : [
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "Current user returned" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2024-01-18 09:56:09 -05:00
"data" : {
"$ref" : "#/components/schemas/UserDetails"
}
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
2024-01-18 09:56:09 -05:00
}
} ,
"/ocs/v2.php/cloud/user/fields" : {
"get" : {
"operationId" : "users-get-editable-fields" ,
"summary" : "Get a list of fields that are editable for the current user" ,
2023-05-24 10:34:27 -04:00
"tags" : [
"users"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
"parameters" : [
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "Editable fields returned" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2024-01-18 09:56:09 -05:00
"data" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
}
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
}
} ,
2024-01-18 09:56:09 -05:00
"/ocs/v2.php/cloud/user/fields/{userId}" : {
2023-05-24 10:34:27 -04:00
"get" : {
2024-01-18 09:56:09 -05:00
"operationId" : "users-get-editable-fields-for-user" ,
"summary" : "Get a list of fields that are editable for a user" ,
2023-05-24 10:34:27 -04:00
"tags" : [
"users"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
"parameters" : [
{
"name" : "userId" ,
"in" : "path" ,
2024-01-18 09:56:09 -05:00
"description" : "ID of the user" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "Editable fields for user returned" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
2024-01-18 09:56:09 -05:00
}
} ,
2025-06-18 10:04:06 -04:00
"/ocs/v2.php/cloud/user/apps" : {
"get" : {
"operationId" : "users-get-enabled-apps" ,
"summary" : "Get a list of enabled apps for the current user" ,
"tags" : [
"users"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
"parameters" : [
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
"description" : "Required to be true for the API request to pass" ,
"required" : true ,
"schema" : {
"type" : "boolean" ,
"default" : true
}
}
] ,
"responses" : {
"200" : {
"description" : "Enabled apps returned" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : {
"type" : "object" ,
"required" : [
"apps"
] ,
"properties" : {
"apps" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
}
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2025-06-18 10:04:06 -04:00
}
}
}
} ,
2024-01-18 09:56:09 -05:00
"/ocs/v2.php/cloud/users/{userId}/{collectionName}" : {
"put" : {
"operationId" : "users-edit-user-multi-value" ,
"summary" : "Update multiple values of the user's details" ,
2024-04-15 03:10:59 -04:00
"description" : "This endpoint requires password confirmation" ,
2023-05-24 10:34:27 -04:00
"tags" : [
"users"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
2024-07-02 03:08:04 -04:00
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"key" ,
"value"
] ,
"properties" : {
"key" : {
"type" : "string" ,
"description" : "Key that will be updated"
} ,
"value" : {
"type" : "string" ,
"description" : "New value for the key"
}
}
}
2023-05-24 10:34:27 -04:00
}
2024-07-02 03:08:04 -04:00
}
} ,
"parameters" : [
2023-05-24 10:34:27 -04:00
{
"name" : "userId" ,
"in" : "path" ,
"description" : "ID of the user" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
2024-01-18 09:56:09 -05:00
{
"name" : "collectionName" ,
"in" : "path" ,
"description" : "Collection to update" ,
"required" : true ,
"schema" : {
"type" : "string" ,
"pattern" : "^(?!enable$|disable$)[a-zA-Z0-9_]*$"
}
} ,
2023-05-24 10:34:27 -04:00
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "User values edited successfully" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2023-02-15 13:27:04 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
2024-01-18 09:56:09 -05:00
}
} ,
"/ocs/v2.php/cloud/users/{userId}/wipe" : {
"post" : {
"operationId" : "users-wipe-user-devices" ,
"summary" : "Wipe all devices of a user" ,
2024-04-15 03:10:59 -04:00
"description" : "This endpoint requires password confirmation" ,
2023-05-24 10:34:27 -04:00
"tags" : [
"users"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
"parameters" : [
{
"name" : "userId" ,
"in" : "path" ,
"description" : "ID of the user" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "Wiped all user devices successfully" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2023-02-15 13:27:04 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
}
} ,
2024-01-18 09:56:09 -05:00
"/ocs/v2.php/cloud/users/{userId}/enable" : {
"put" : {
"operationId" : "users-enable-user" ,
"summary" : "Enable a user" ,
2024-04-15 03:10:59 -04:00
"description" : "This endpoint requires password confirmation" ,
2023-05-24 10:34:27 -04:00
"tags" : [
"users"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
"parameters" : [
{
"name" : "userId" ,
"in" : "path" ,
2024-01-18 09:56:09 -05:00
"description" : "ID of the user" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "User enabled successfully" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2023-02-15 13:27:04 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
}
} ,
2024-01-18 09:56:09 -05:00
"/ocs/v2.php/cloud/users/{userId}/disable" : {
"put" : {
"operationId" : "users-disable-user" ,
"summary" : "Disable a user" ,
2024-04-15 03:10:59 -04:00
"description" : "This endpoint requires password confirmation" ,
2023-05-24 10:34:27 -04:00
"tags" : [
2024-01-18 09:56:09 -05:00
"users"
2023-05-24 10:34:27 -04:00
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
"parameters" : [
2024-01-18 09:56:09 -05:00
{
"name" : "userId" ,
"in" : "path" ,
"description" : "ID of the user" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
2023-05-24 10:34:27 -04:00
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "User disabled successfully" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2024-01-18 09:56:09 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
}
} ,
2024-01-18 09:56:09 -05:00
"/ocs/v2.php/cloud/users/{userId}/groups" : {
2023-05-24 10:34:27 -04:00
"get" : {
2024-01-18 09:56:09 -05:00
"operationId" : "users-get-users-groups" ,
"summary" : "Get a list of groups the user belongs to" ,
2023-05-24 10:34:27 -04:00
"tags" : [
2024-01-18 09:56:09 -05:00
"users"
2023-05-24 10:34:27 -04:00
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
"parameters" : [
{
2024-01-18 09:56:09 -05:00
"name" : "userId" ,
2023-05-24 10:34:27 -04:00
"in" : "path" ,
2024-01-18 09:56:09 -05:00
"description" : "ID of the user" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "Users groups returned" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : {
"type" : "object" ,
"required" : [
2024-01-18 09:56:09 -05:00
"groups"
2023-05-24 10:34:27 -04:00
] ,
"properties" : {
2024-01-18 09:56:09 -05:00
"groups" : {
2023-05-24 10:34:27 -04:00
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
}
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
2024-01-18 09:56:09 -05:00
} ,
"post" : {
"operationId" : "users-add-to-group" ,
"summary" : "Add a user to a group" ,
2024-04-15 03:10:59 -04:00
"description" : "This endpoint requires password confirmation" ,
2023-05-24 10:34:27 -04:00
"tags" : [
2024-01-18 09:56:09 -05:00
"users"
2023-05-24 10:34:27 -04:00
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
2024-07-02 03:08:04 -04:00
"requestBody" : {
"required" : false ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"properties" : {
"groupid" : {
"type" : "string" ,
"default" : "" ,
"description" : "ID of the group"
}
}
}
2023-05-24 10:34:27 -04:00
}
2024-07-02 03:08:04 -04:00
}
} ,
"parameters" : [
2023-05-24 10:34:27 -04:00
{
2024-01-18 09:56:09 -05:00
"name" : "userId" ,
2023-05-24 10:34:27 -04:00
"in" : "path" ,
2024-01-18 09:56:09 -05:00
"description" : "ID of the user" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
2025-08-26 04:21:10 -04:00
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
"description" : "Required to be true for the API request to pass" ,
"required" : true ,
"schema" : {
"type" : "boolean" ,
"default" : true
}
}
] ,
"responses" : {
"200" : {
"description" : "User added to group successfully" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
} ,
"401" : {
"description" : "Current user is not logged in" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2024-01-18 09:56:09 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
}
}
} ,
2024-01-18 09:56:09 -05:00
"delete" : {
"operationId" : "users-remove-from-group" ,
"summary" : "Remove a user from a group" ,
2024-04-15 03:10:59 -04:00
"description" : "This endpoint requires password confirmation" ,
2023-05-24 10:34:27 -04:00
"tags" : [
2024-01-18 09:56:09 -05:00
"users"
2023-05-24 10:34:27 -04:00
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
2024-07-02 03:08:04 -04:00
"parameters" : [
2023-05-24 10:34:27 -04:00
{
2024-01-18 09:56:09 -05:00
"name" : "userId" ,
2023-05-24 10:34:27 -04:00
"in" : "path" ,
2024-01-18 09:56:09 -05:00
"description" : "ID of the user" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
2024-08-19 05:08:28 -04:00
{
"name" : "groupid" ,
"in" : "query" ,
"description" : "ID of the group" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
2023-05-24 10:34:27 -04:00
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "User removed from group successfully" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2023-02-15 13:27:04 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
}
2025-03-25 17:31:45 -04:00
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2025-03-25 17:31:45 -04:00
}
}
}
} ,
"/ocs/v2.php/cloud/users/{userId}/groups/details" : {
"get" : {
"operationId" : "users-get-users-groups-details" ,
"summary" : "Get a list of groups with details" ,
"tags" : [
"users"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
"parameters" : [
{
"name" : "userId" ,
"in" : "path" ,
"description" : "ID of the user" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
"description" : "Required to be true for the API request to pass" ,
"required" : true ,
"schema" : {
"type" : "boolean" ,
"default" : true
}
}
] ,
"responses" : {
"200" : {
"description" : "Users groups returned" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : {
"type" : "object" ,
"required" : [
"groups"
] ,
"properties" : {
"groups" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/GroupDetails"
}
}
}
}
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2025-03-25 17:31:45 -04:00
}
}
}
} ,
"/ocs/v2.php/cloud/users/{userId}/subadmins/details" : {
"get" : {
"operationId" : "users-get-user-sub-admin-groups-details" ,
"summary" : "Get a list of the groups the user is a subadmin of, with details" ,
"tags" : [
"users"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
"parameters" : [
{
"name" : "userId" ,
"in" : "path" ,
"description" : "ID of the user" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
"description" : "Required to be true for the API request to pass" ,
"required" : true ,
"schema" : {
"type" : "boolean" ,
"default" : true
}
}
] ,
"responses" : {
"200" : {
"description" : "Users subadmin groups returned" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : {
"type" : "object" ,
"required" : [
"groups"
] ,
"properties" : {
"groups" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/GroupDetails"
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2024-01-18 09:56:09 -05:00
}
}
}
} ,
"/ocs/v2.php/cloud/users/{userId}/welcome" : {
"post" : {
"operationId" : "users-resend-welcome-message" ,
"summary" : "Resend the welcome message" ,
2024-04-15 03:10:59 -04:00
"description" : "This endpoint requires password confirmation" ,
2024-01-18 09:56:09 -05:00
"tags" : [
"users"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
"parameters" : [
{
"name" : "userId" ,
"in" : "path" ,
"description" : "ID if the user" ,
"required" : true ,
"schema" : {
"type" : "string"
}
2023-05-24 10:34:27 -04:00
} ,
2024-01-18 09:56:09 -05:00
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
"description" : "Required to be true for the API request to pass" ,
"required" : true ,
"schema" : {
"type" : "boolean" ,
"default" : true
}
}
] ,
"responses" : {
"200" : {
"description" : "Resent welcome message successfully" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2024-01-18 09:56:09 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
2024-01-18 09:56:09 -05:00
}
} ,
"/ocs/v2.php/apps/provisioning_api/api/v1/config/apps/{app}/{key}" : {
"post" : {
"operationId" : "app_config-set-value" ,
"summary" : "Update the config value of an app" ,
2024-04-15 03:10:59 -04:00
"description" : "This endpoint requires password confirmation" ,
2023-05-24 10:34:27 -04:00
"tags" : [
"app_config"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
2024-07-02 03:08:04 -04:00
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"value"
] ,
"properties" : {
"value" : {
"type" : "string" ,
"description" : "New value for the key"
}
}
}
2024-01-18 09:56:09 -05:00
}
2024-07-02 03:08:04 -04:00
}
} ,
"parameters" : [
2023-05-24 10:34:27 -04:00
{
"name" : "app" ,
"in" : "path" ,
"description" : "ID of the app" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "key" ,
"in" : "path" ,
2024-01-18 09:56:09 -05:00
"description" : "Key to update" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
2024-01-18 09:56:09 -05:00
"description" : "Value updated successfully" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2023-02-15 13:27:04 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
} ,
"403" : {
2023-02-15 13:27:04 -05:00
"description" : "App or key is not allowed" ,
2023-05-24 10:34:27 -04:00
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : {
"type" : "object" ,
"required" : [
"data"
] ,
"properties" : {
"data" : {
"type" : "object" ,
"required" : [
"message"
] ,
"properties" : {
"message" : {
"type" : "string"
}
}
}
}
}
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
}
} ,
"/ocs/v2.php/apps/provisioning_api/api/v1/config/users/{appId}/{configKey}" : {
"post" : {
"operationId" : "preferences-set-preference" ,
"summary" : "Update a preference value of an app" ,
"tags" : [
"preferences"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
2024-07-02 03:08:04 -04:00
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"configValue"
] ,
"properties" : {
"configValue" : {
"type" : "string" ,
"description" : "New value"
}
}
}
2023-05-24 10:34:27 -04:00
}
2024-07-02 03:08:04 -04:00
}
} ,
"parameters" : [
2023-05-24 10:34:27 -04:00
{
"name" : "appId" ,
"in" : "path" ,
"description" : "ID of the app" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "configKey" ,
"in" : "path" ,
"description" : "Key of the preference" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
"description" : "Preference updated successfully" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2023-02-15 13:27:04 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
} ,
"400" : {
"description" : "Preference invalid" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2023-02-15 13:27:04 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
} ,
"delete" : {
"operationId" : "preferences-delete-preference" ,
"summary" : "Delete a preference for an app" ,
"tags" : [
"preferences"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
"parameters" : [
{
"name" : "appId" ,
"in" : "path" ,
"description" : "ID of the app" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "configKey" ,
"in" : "path" ,
"description" : "Key to delete" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
"description" : "Preference deleted successfully" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2023-02-15 13:27:04 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
} ,
"400" : {
"description" : "Preference invalid" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2023-02-15 13:27:04 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
}
} ,
"/ocs/v2.php/apps/provisioning_api/api/v1/config/users/{appId}" : {
"post" : {
"operationId" : "preferences-set-multiple-preferences" ,
"summary" : "Update multiple preference values of an app" ,
"tags" : [
"preferences"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
2024-07-02 03:08:04 -04:00
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"configs"
] ,
"properties" : {
"configs" : {
"type" : "object" ,
"description" : "Key-value pairs of the preferences" ,
"additionalProperties" : {
"type" : "string"
}
}
}
}
2023-05-24 10:34:27 -04:00
}
2024-07-02 03:08:04 -04:00
}
} ,
"parameters" : [
2023-05-24 10:34:27 -04:00
{
"name" : "appId" ,
"in" : "path" ,
"description" : "ID of the app" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
"description" : "Preferences updated successfully" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2023-02-15 13:27:04 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
} ,
"400" : {
"description" : "Preference invalid" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2023-02-15 13:27:04 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
2025-08-26 04:21:10 -04:00
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
2023-05-24 10:34:27 -04:00
}
}
} ,
"delete" : {
"operationId" : "preferences-delete-multiple-preference" ,
"summary" : "Delete multiple preferences for an app" ,
"tags" : [
"preferences"
] ,
"security" : [
{
"bearer_auth" : [ ]
} ,
{
"basic_auth" : [ ]
}
] ,
2024-07-02 03:08:04 -04:00
"parameters" : [
2023-05-24 10:34:27 -04:00
{
"name" : "appId" ,
"in" : "path" ,
"description" : "ID of the app" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
2024-08-19 05:08:28 -04:00
{
"name" : "configKeys[]" ,
"in" : "query" ,
"description" : "Keys to delete" ,
"required" : true ,
"schema" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
}
} ,
2023-05-24 10:34:27 -04:00
{
"name" : "OCS-APIRequest" ,
"in" : "header" ,
2023-09-27 04:22:20 -04:00
"description" : "Required to be true for the API request to pass" ,
2023-05-24 10:34:27 -04:00
"required" : true ,
"schema" : {
2023-09-27 04:22:20 -04:00
"type" : "boolean" ,
"default" : true
2023-05-24 10:34:27 -04:00
}
}
] ,
"responses" : {
"200" : {
"description" : "Preferences deleted successfully" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2023-02-15 13:27:04 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
} ,
"400" : {
"description" : "Preference invalid" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
2025-08-26 04:21:10 -04:00
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
"data" : { }
}
}
}
}
}
}
} ,
"401" : {
"description" : "Current user is not logged in" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"required" : [
"ocs"
] ,
2023-05-24 10:34:27 -04:00
"properties" : {
"ocs" : {
"type" : "object" ,
"required" : [
"meta" ,
"data"
] ,
"properties" : {
"meta" : {
"$ref" : "#/components/schemas/OCSMeta"
} ,
2023-02-15 13:27:04 -05:00
"data" : { }
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
}
}
}
}
} ,
"tags" : [ ]
2024-07-02 03:08:04 -04:00
}
