Update organization settings

patch

https://api.controlup.com/v1/organizations/{orgId}/settings

Updates your organization settings by setting the value of the parameters passed.
Any parameters not passed are not changed.

Required permissions - Depending on which settings you want to update:

Manage Login Methods
Manage MFA
Manage Default Home Page
Manage session timeout
Manage IP Restrictions

Path Params

orgId

uuid

required

^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$

ID of your ControlUp organization. You can find your organization ID on the API Key Management page in the DEX platform.

Body Params

loginMethods

array of objects

An array of allowed login methods.

loginMethods

Allowed:

vdiDassLdapLogin

boolean | null

Whether LDAP is used for authorization to your VDI & DaaS environment.

mfas

array of objects

An array of allowed multi-factor authentication methods.

mfas

Allowed:

defaultHomePage

string

enum

The default landing page when a user signs in to your organization.
The names for each page in the API are not the same as what you see in the application UI.
See the table below for the API name of each page.

Show Details

employee	Employees
devices	Devices
ucc	UC&C
sentiment	Employee Sentiment
solve	VDI & DaaS
eucReports	Reports
scoutBees	Synthetic Monitoring
srm	Secure DX

sessionTimeoutInMinutes

int32

1 to 1440

The number of minutes of inactivity before a user is signed out of your organization on app.controlup.com.

rtdxSessionTimeoutInMinutes

int32

1 to 1440

The number of minutes of inactivity before a user is signed out of the Real-Time DX Console desktop application.
After the timeout duration, the Console closes and you must sign in again.

activeSessionTimeoutInMinutes

int32

1 to 1440

The absolute maximum duration in minutes of a session, regardless of activity. When the limit is reached,
the user receives a warning and is signed out of your organization on app.controlup.com.

ipAllowlistEnabled

boolean

Whether the IP allowlist is enabled.
If enabled, only IP addresses on the allowlist can access your organization.
The IP address of the first user who enables the IP allowlist is automatically added to the allowlist.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok

400Bad Request

401Unauthorized: Access is denied

403Forbidden: Access to this resource is denied

404Not Found: The requested resource could not be found

500Internal Server Error