Download OpenAPI specification:Download
Documentation of the Open-Xchange Cloud-Plugins Rest APIs.
change user data
contextid required | number context id |
userid required | number user id |
put parameters
custom | string 1 items |
{- "custom": "string"
}
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}
change user data
contextid required | number context id |
userid required | number user id |
put parameters
msisdn | string 1 items |
{- "msisdn": "string"
}
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}
get uidname of user
search required | string string to search for |
field | string Enum: "UIDNAME" "MSISDN" "CUSTOM" "ANY" field to search into |
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}
change user data
contextid required | number context id |
userid required | number user id |
put parameters
uidname | string 1 items |
{- "uidname": "string"
}
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}
change user data
contextid required | number context id |
userid required | number user id |
post parameters
msisdn | string >= 0 items |
custom | Array of strings >= 0 items |
{- "msisdn": "+49.12345.6789",
- "custom": [
- "id 1",
- "id 2"
]
}
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}
get whole config of the user
contextid required | number context id |
userid required | number user id |
{- "userconfig": [
- {
- "name": "com.openexchange.first.config",
- "scope": "server",
- "value": "true"
}, - {
- "name": "com.openexchange.second.config",
- "scope": "user",
- "value": "false"
}
]
}
get whole config of the user
contextid required | number context id |
userid required | number user id |
searchpattern required | string Search Pattern to filter the list of returned configurations |
{- "userconfig": [
- {
- "name": "com.openexchange.filtered.config.1",
- "scope": "server",
- "value": "true"
}, - {
- "name": "com.openexchange.filtered.config.2",
- "scope": "user",
- "value": "false"
}
]
}