NEnexla
Organizations

Update an Organization

Updates properties of an organization.

put/orgs/{org_id}

Request

Path parameters

org_idinteger required

The unique ID of the organization that needs to be updated.

Request body

namestring
owner_idinteger
billing_owner_idinteger
email_domainstring
client_identifierstring

Recommended but not required. This is a unique identifier for the organization in the environment. This identifier is especially useful for organizations that are using SSO.

Recommendation: Use the organization's domain name. Apply variants if a company needs more than one organization account in the environment.

enable_nexla_password_loginboolean

Set to false if an organization requires no user to be allowed username-password-based access. Applicable for organizations who use GSuite email or have SSO enabled.

Default value: true

Response

Success

idinteger
namestring
descriptionunknown
cluster_idinteger
new_cluster_idunknown
cluster_statusstring
email_domainstring
emailunknown
client_identifierstring
org_webhook_hoststring url
access_rolesstring[]

This property reflects all the permissions the user/team/organization has to this resource.

  1. collaborator: The user/team/organization can view the resource but not make any modifications to it.
  2. operator: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it.
  3. administrator: The user/team/organization has complete administrative rights to this resource.
  4. owner: This user created the resource and so has complete administrative rights to it.
members_default_access_rolestring
statusstring
default_reusable_code_container_access_rolestring
require_org_admin_to_publishboolean
require_org_admin_to_subscribeboolean
email_domain_verified_atunknown
name_verified_atunknown
enable_nexla_password_loginboolean
updated_atstring date-time
created_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.