Retrieve general settings

Retrieves organization-wide setting details, including password and security settings.

Responses

200
default

Success

application/api.clumio.general-settings=v2+json

Schema
Example (from schema)

Schema

_links object
URLs to pages related to the resource.
_self object
The HATEOAS link to this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
update-general-settings object
A resource-specific HATEOAS link.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
auto_logout_duration int64
Possible values: >= 600 and <= 3600
The length of time before a user is logged out of the Clumio system due to inactivity. Measured in seconds. The valid range is between 600 seconds (10 minutes) and 3600 seconds (60 minutes). If not configured, the value defaults to 900 seconds (15 minutes).
ip_allowlist string[]
The designated range of IP addresses that are allowed to access the Clumio REST API. API requests that originate from outside this list will be blocked. The IP address of the server from which this request is being made must be in this list; otherwise, the request will fail. Set the parameter to individual IP addresses and/or a range of IP addresses in CIDR notation. For example, ["193.168.1.0/24", "193.172.1.1"]. If not configured, the value defaults to ["0.0.0.0/0"] meaning all addresses will be allowed.
organizational_unit_data_groups object
The grouping criteria for each datasource type. These can only be edited for datasource types which do not have any organizational units configured.
aws object
The entity type used to group organizational units for AWS resources.
is_editable boolean
Determines whether or not this data group is editable. If false, then an organizational unit uses this data group. To edit this data group, all organizational units using it must be deleted.
type AwsOrganizationalUnitEntityType. The entity type used to group organizational units for AWS resources.

Entity Type Details
aws_environment AWS account and region.
microsoft365 object
The entity type used to group organizational units for Microsoft 365 resources.
is_editable boolean
Determines whether or not this data group is editable. If false, then an organizational unit uses this data group. To edit this data group, all organizational units using it must be deleted.
type M365OrganizationalUnitEntityType. The entity type used to group organizational units for Microsoft 365 resources.

Entity Type Details
microsoft365_domain Microsoft 365 account.
password_expiration_duration int64
Possible values: >= 2592000 and <= 15552000
The length of time a user password is valid before it must be changed. Measured in seconds. The valid range is between 2592000 seconds (30 days) and 15552000 seconds (180 days). If not configured, the value defaults to 7776000 seconds (90 days).

Entity Type	Details
aws_environment	AWS account and region.

Entity Type	Details
microsoft365_domain	Microsoft 365 account.

{
  "_links": {
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "update-general-settings": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "auto_logout_duration": 0,
  "ip_allowlist": [
    "string"
  ],
  "organizational_unit_data_groups": {
    "aws": {
      "is_editable": true,
      "type": "string"
    },
    "microsoft365": {
      "is_editable": true,
      "type": "string"
    }
  },
  "password_expiration_duration": 0
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

GET /settings/general

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

curl -L -X GET 'https://us-west-2.api.clumio.com/settings/general' \
-H 'Accept: application/api.clumio.general-settings=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/settings/general' \
-H 'Accept: application/api.clumio.general-settings=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/settings/general' \
-H 'Accept: application/api.clumio.general-settings=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/settings/general' \
-H 'Accept: application/api.clumio.general-settings=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/settings/general' \
-H 'Accept: application/api.clumio.general-settings=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/settings/general' \
-H 'Accept: application/api.clumio.general-settings=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/settings/general' \
-H 'Accept: application/api.clumio.general-settings=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

Retrieve general settings​

Authorization

Request

Retrieve general settings