User Config Interface

Get user's hub properties

GET/api/v6.1.0.7/hubs/{hub}/users/{user}/props

Query parameters	Prototype: `'fetch' ?: ( prop+ )`
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `prop *: value`
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	CurrentUser access level Available while Setup Mode is active.

PATCH/api/v6.1.0.7/hubs/{hub}/users/{user}/props

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `prop *: value \|`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request
Required permissions	CurrentUser access level Available while Setup Mode is active.
Events	Creates no events.

PUT/api/v6.1.0.7/hubs/{hub}/users/{user}/props

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `prop *: value`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request
Required permissions	CurrentUser access level Available while Setup Mode is active.
Events	Creates no events.

POST/api/v6.1.0.7/hubs/{hub}/users/{user}/props_delete

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'props' : ( prop+ )`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request
Required permissions	CurrentUser access level Available while Setup Mode is active.
Events	Creates no events.

POST/api/v6.1.0.7/hubs/{hub}/users/{user}/props_modify

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'user_hub_prop_args' : ( { 'key' : ( prop \| \| * ) 'value' : }+ )`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request
Required permissions	CurrentUser access level Available while Setup Mode is active.
Events	Creates no events.

GET/api/v6.1.0.7/users

Query parameters	Prototype: `'fetch' ?: field_or_prop( 'authentication' \| 'contact_props' \| 'all_props' \| + )`
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `user : { 'authentication' ?: 'local' \| 'pam' \| 'plugin' \| 'windows' 'props' ?: { prop : value } }`
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	No special permission required Available while Setup Mode is active.

POST/api/v6.1.0.7/users

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'user' : name 'authentication' : 'local' \| 'pam' \| 'plugin' \| 'windows' 'password' ?: 'props' ?: { prop *: value }`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request: User already exists
Required permissions	SysAdmin access level Available while Setup Mode is active.
Events	Creates the following event User_Create `'user' : name 'authentication' : 'local' \| 'pam' \| 'plugin' \| 'windows'`

DELETE/api/v6.1.0.7/users/{user}

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: User doesn't exist
Required permissions	SysAdmin access level Available while Setup Mode is active.
Events	Creates the following event User_Delete `'user' : name`

GET/api/v6.1.0.7/users/{user}

Query parameters	Prototype: `'fetch' ?: field_or_prop( 'authentication' \| 'contact_props' \| 'all_props' \| + )`
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `'authentication' ?: 'local' \| 'pam' \| 'plugin' \| 'windows' 'props' ?: { prop *: value }`
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	No special permission required Available while Setup Mode is active.

PUT/api/v6.1.0.7/users/{user}/password

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'new_password' : 'current_password' ?:`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request: User does not have local authentication ❌ 404 Not Found: User doesn't exist
Required permissions	CurrentUser access level Available while Setup Mode is active.
Events	Creates the following event User_Password_Change `'user' : name`

GET/api/v6.1.0.7/users/{user}/props

Query parameters	Prototype: `'fetch' ?: ( prop+ )`
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `prop *: value`
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	No special permission required Available while Setup Mode is active.

PATCH/api/v6.1.0.7/users/{user}/props

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `prop *: value \|`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request
Required permissions	CurrentUser access level Available while Setup Mode is active.
Events	Creates no events.

PUT/api/v6.1.0.7/users/{user}/props

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `prop *: value`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request
Required permissions	CurrentUser access level Available while Setup Mode is active.
Events	Creates no events.

POST/api/v6.1.0.7/users/{user}/props_delete

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'props' : ( prop+ )`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request
Required permissions	CurrentUser access level Available while Setup Mode is active.
Events	Creates no events.

POST/api/v6.1.0.7/users/{user}/props_modify

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'user_prop_args' : ( { 'key' : ( prop \| \| * ) 'value' : }+ )`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request
Required permissions	CurrentUser access level Available while Setup Mode is active.
Events	Creates no events.