diff --git a/content/en/api/v2/org-groups/examples.json b/content/en/api/v2/org-groups/examples.json index 019b8e23ae0..24bcb4da2b4 100644 --- a/content/en/api/v2/org-groups/examples.json +++ b/content/en/api/v2/org-groups/examples.json @@ -563,7 +563,7 @@ "content": { "value": "UTC" }, - "enforcement_tier": "DEFAULT", + "enforcement_tier": "OVERRIDE_ALLOWED", "modified_at": "2024-01-15T10:30:00Z", "policy_name": "monitor_timezone", "policy_type": "org_config" @@ -600,7 +600,7 @@ } } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of org group policies.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an org group policy.

\n
\n
\n
\n
\n
\n

content

\n
\n

object

\n

The policy content as key-value pairs.

\n
\n \n
\n
\n
\n
\n
\n

enforcement_tier [required]

\n
\n

enum

\n

The enforcement tier of the policy. DEFAULT means the policy is set but member orgs may mutate it. ENFORCE means the policy is strictly controlled and mutations are blocked for affected orgs. DELEGATE means each member org controls its own value. \nAllowed enum values: DEFAULT,ENFORCE,DELEGATE

default: DEFAULT

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the policy was last modified.

\n
\n \n
\n
\n
\n
\n
\n

policy_name [required]

\n
\n

string

\n

The name of the policy.

\n
\n \n
\n
\n
\n
\n
\n

policy_type [required]

\n
\n

enum

\n

The type of the policy. Only org_config is supported, indicating a policy backed by an organization configuration setting. \nAllowed enum values: org_config

default: org_config

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group policy.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of an org group policy.

\n
\n
\n
\n
\n
\n

org_group

\n
\n

object

\n

Relationship to a single org group.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A reference to an org group.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org group policies resource type. \nAllowed enum values: org_group_policies

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Pagination links for navigating between pages of an org group list response.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

Link to the first page.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Link to the last page.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Link to the next page.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Link to the previous page.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Link to the current page.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Pagination metadata for org group list responses.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Page-based pagination details for org group list responses.

\n
\n
\n
\n
\n
\n

first_number

\n
\n

int64

\n

First page number.

\n
\n \n
\n
\n
\n
\n
\n

last_number

\n
\n

int64

\n

Last page number.

\n
\n \n
\n
\n
\n
\n
\n

next_number

\n
\n

int64

\n

Next page number.

\n
\n \n
\n
\n
\n
\n
\n

number

\n
\n

int64

\n

Page number.

\n
\n \n
\n
\n
\n
\n
\n

prev_number

\n
\n

int64

\n

Previous page number.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Page size.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total number of results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Pagination type.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of org group policies.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an org group policy.

\n
\n
\n
\n
\n
\n

content

\n
\n

object

\n

The policy content as key-value pairs.

\n
\n \n
\n
\n
\n
\n
\n

enforcement_tier [required]

\n
\n

enum

\n

The enforcement tier of the policy. OVERRIDE_ALLOWED means the policy is set but member orgs may mutate it. GROUP_MANAGED means the policy is strictly controlled and mutations are blocked for affected orgs. DELEGATE means each member org controls its own value. \nAllowed enum values: OVERRIDE_ALLOWED,GROUP_MANAGED,DELEGATE

default: OVERRIDE_ALLOWED

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the policy was last modified.

\n
\n \n
\n
\n
\n
\n
\n

policy_name [required]

\n
\n

string

\n

The name of the policy.

\n
\n \n
\n
\n
\n
\n
\n

policy_type [required]

\n
\n

enum

\n

The type of the policy. Only org_config is supported, indicating a policy backed by an organization configuration setting. \nAllowed enum values: org_config

default: org_config

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group policy.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of an org group policy.

\n
\n
\n
\n
\n
\n

org_group

\n
\n

object

\n

Relationship to a single org group.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A reference to an org group.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org group policies resource type. \nAllowed enum values: org_group_policies

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Pagination links for navigating between pages of an org group list response.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

Link to the first page.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Link to the last page.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Link to the next page.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Link to the previous page.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Link to the current page.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Pagination metadata for org group list responses.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Page-based pagination details for org group list responses.

\n
\n
\n
\n
\n
\n

first_number

\n
\n

int64

\n

First page number.

\n
\n \n
\n
\n
\n
\n
\n

last_number

\n
\n

int64

\n

Last page number.

\n
\n \n
\n
\n
\n
\n
\n

next_number

\n
\n

int64

\n

Next page number.

\n
\n \n
\n
\n
\n
\n
\n

number

\n
\n

int64

\n

Page number.

\n
\n \n
\n
\n
\n
\n
\n

prev_number

\n
\n

int64

\n

Previous page number.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Page size.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total number of results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Pagination type.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -680,7 +680,7 @@ "content": { "value": "UTC" }, - "enforcement_tier": "DEFAULT", + "enforcement_tier": "OVERRIDE_ALLOWED", "modified_at": "2024-01-15T10:30:00Z", "policy_name": "monitor_timezone", "policy_type": "org_config" @@ -697,7 +697,7 @@ "type": "org_group_policies" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

An org group policy resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an org group policy.

\n
\n
\n
\n
\n
\n

content

\n
\n

object

\n

The policy content as key-value pairs.

\n
\n \n
\n
\n
\n
\n
\n

enforcement_tier [required]

\n
\n

enum

\n

The enforcement tier of the policy. DEFAULT means the policy is set but member orgs may mutate it. ENFORCE means the policy is strictly controlled and mutations are blocked for affected orgs. DELEGATE means each member org controls its own value. \nAllowed enum values: DEFAULT,ENFORCE,DELEGATE

default: DEFAULT

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the policy was last modified.

\n
\n \n
\n
\n
\n
\n
\n

policy_name [required]

\n
\n

string

\n

The name of the policy.

\n
\n \n
\n
\n
\n
\n
\n

policy_type [required]

\n
\n

enum

\n

The type of the policy. Only org_config is supported, indicating a policy backed by an organization configuration setting. \nAllowed enum values: org_config

default: org_config

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group policy.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of an org group policy.

\n
\n
\n
\n
\n
\n

org_group

\n
\n

object

\n

Relationship to a single org group.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A reference to an org group.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org group policies resource type. \nAllowed enum values: org_group_policies

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

An org group policy resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an org group policy.

\n
\n
\n
\n
\n
\n

content

\n
\n

object

\n

The policy content as key-value pairs.

\n
\n \n
\n
\n
\n
\n
\n

enforcement_tier [required]

\n
\n

enum

\n

The enforcement tier of the policy. OVERRIDE_ALLOWED means the policy is set but member orgs may mutate it. GROUP_MANAGED means the policy is strictly controlled and mutations are blocked for affected orgs. DELEGATE means each member org controls its own value. \nAllowed enum values: OVERRIDE_ALLOWED,GROUP_MANAGED,DELEGATE

default: OVERRIDE_ALLOWED

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the policy was last modified.

\n
\n \n
\n
\n
\n
\n
\n

policy_name [required]

\n
\n

string

\n

The name of the policy.

\n
\n \n
\n
\n
\n
\n
\n

policy_type [required]

\n
\n

enum

\n

The type of the policy. Only org_config is supported, indicating a policy backed by an organization configuration setting. \nAllowed enum values: org_config

default: org_config

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group policy.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of an org group policy.

\n
\n
\n
\n
\n
\n

org_group

\n
\n

object

\n

Relationship to a single org group.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A reference to an org group.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org group policies resource type. \nAllowed enum values: org_group_policies

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -806,7 +806,7 @@ "content": { "value": "UTC" }, - "enforcement_tier": "DEFAULT", + "enforcement_tier": "OVERRIDE_ALLOWED", "policy_name": "monitor_timezone", "policy_type": "org_config" }, @@ -821,7 +821,7 @@ "type": "org_group_policies" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for creating an org group policy.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating an org group policy. If policy_type or enforcement_tier are not provided, they default to org_config and DEFAULT respectively.

\n
\n
\n
\n
\n
\n

content [required]

\n
\n

object

\n

The policy content as key-value pairs.

\n
\n \n
\n
\n
\n
\n
\n

enforcement_tier

\n
\n

enum

\n

The enforcement tier of the policy. DEFAULT means the policy is set but member orgs may mutate it. ENFORCE means the policy is strictly controlled and mutations are blocked for affected orgs. DELEGATE means each member org controls its own value. \nAllowed enum values: DEFAULT,ENFORCE,DELEGATE

default: DEFAULT

\n
\n \n
\n
\n
\n
\n
\n

policy_name [required]

\n
\n

string

\n

The name of the policy.

\n
\n \n
\n
\n
\n
\n
\n

policy_type

\n
\n

enum

\n

The type of the policy. Only org_config is supported, indicating a policy backed by an organization configuration setting. \nAllowed enum values: org_config

default: org_config

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for creating a policy.

\n
\n
\n
\n
\n
\n

org_group [required]

\n
\n

object

\n

Relationship to a single org group.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A reference to an org group.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org group policies resource type. \nAllowed enum values: org_group_policies

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for creating an org group policy.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating an org group policy. If policy_type or enforcement_tier are not provided, they default to org_config and DEFAULT respectively.

\n
\n
\n
\n
\n
\n

content [required]

\n
\n

object

\n

The policy content as key-value pairs.

\n
\n \n
\n
\n
\n
\n
\n

enforcement_tier

\n
\n

enum

\n

The enforcement tier of the policy. OVERRIDE_ALLOWED means the policy is set but member orgs may mutate it. GROUP_MANAGED means the policy is strictly controlled and mutations are blocked for affected orgs. DELEGATE means each member org controls its own value. \nAllowed enum values: OVERRIDE_ALLOWED,GROUP_MANAGED,DELEGATE

default: OVERRIDE_ALLOWED

\n
\n \n
\n
\n
\n
\n
\n

policy_name [required]

\n
\n

string

\n

The name of the policy.

\n
\n \n
\n
\n
\n
\n
\n

policy_type

\n
\n

enum

\n

The type of the policy. Only org_config is supported, indicating a policy backed by an organization configuration setting. \nAllowed enum values: org_config

default: org_config

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for creating a policy.

\n
\n
\n
\n
\n
\n

org_group [required]

\n
\n

object

\n

Relationship to a single org group.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A reference to an org group.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org group policies resource type. \nAllowed enum values: org_group_policies

\n
\n \n
\n
\n
\n
" } }, "DeleteOrgGroupPolicy": { @@ -922,7 +922,7 @@ "content": { "value": "UTC" }, - "enforcement_tier": "DEFAULT", + "enforcement_tier": "OVERRIDE_ALLOWED", "modified_at": "2024-01-15T10:30:00Z", "policy_name": "monitor_timezone", "policy_type": "org_config" @@ -939,7 +939,7 @@ "type": "org_group_policies" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

An org group policy resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an org group policy.

\n
\n
\n
\n
\n
\n

content

\n
\n

object

\n

The policy content as key-value pairs.

\n
\n \n
\n
\n
\n
\n
\n

enforcement_tier [required]

\n
\n

enum

\n

The enforcement tier of the policy. DEFAULT means the policy is set but member orgs may mutate it. ENFORCE means the policy is strictly controlled and mutations are blocked for affected orgs. DELEGATE means each member org controls its own value. \nAllowed enum values: DEFAULT,ENFORCE,DELEGATE

default: DEFAULT

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the policy was last modified.

\n
\n \n
\n
\n
\n
\n
\n

policy_name [required]

\n
\n

string

\n

The name of the policy.

\n
\n \n
\n
\n
\n
\n
\n

policy_type [required]

\n
\n

enum

\n

The type of the policy. Only org_config is supported, indicating a policy backed by an organization configuration setting. \nAllowed enum values: org_config

default: org_config

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group policy.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of an org group policy.

\n
\n
\n
\n
\n
\n

org_group

\n
\n

object

\n

Relationship to a single org group.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A reference to an org group.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org group policies resource type. \nAllowed enum values: org_group_policies

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

An org group policy resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an org group policy.

\n
\n
\n
\n
\n
\n

content

\n
\n

object

\n

The policy content as key-value pairs.

\n
\n \n
\n
\n
\n
\n
\n

enforcement_tier [required]

\n
\n

enum

\n

The enforcement tier of the policy. OVERRIDE_ALLOWED means the policy is set but member orgs may mutate it. GROUP_MANAGED means the policy is strictly controlled and mutations are blocked for affected orgs. DELEGATE means each member org controls its own value. \nAllowed enum values: OVERRIDE_ALLOWED,GROUP_MANAGED,DELEGATE

default: OVERRIDE_ALLOWED

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the policy was last modified.

\n
\n \n
\n
\n
\n
\n
\n

policy_name [required]

\n
\n

string

\n

The name of the policy.

\n
\n \n
\n
\n
\n
\n
\n

policy_type [required]

\n
\n

enum

\n

The type of the policy. Only org_config is supported, indicating a policy backed by an organization configuration setting. \nAllowed enum values: org_config

default: org_config

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group policy.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of an org group policy.

\n
\n
\n
\n
\n
\n

org_group

\n
\n

object

\n

Relationship to a single org group.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A reference to an org group.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org group policies resource type. \nAllowed enum values: org_group_policies

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1037,7 +1037,7 @@ "content": { "value": "UTC" }, - "enforcement_tier": "DEFAULT", + "enforcement_tier": "OVERRIDE_ALLOWED", "modified_at": "2024-01-15T10:30:00Z", "policy_name": "monitor_timezone", "policy_type": "org_config" @@ -1054,7 +1054,7 @@ "type": "org_group_policies" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

An org group policy resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an org group policy.

\n
\n
\n
\n
\n
\n

content

\n
\n

object

\n

The policy content as key-value pairs.

\n
\n \n
\n
\n
\n
\n
\n

enforcement_tier [required]

\n
\n

enum

\n

The enforcement tier of the policy. DEFAULT means the policy is set but member orgs may mutate it. ENFORCE means the policy is strictly controlled and mutations are blocked for affected orgs. DELEGATE means each member org controls its own value. \nAllowed enum values: DEFAULT,ENFORCE,DELEGATE

default: DEFAULT

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the policy was last modified.

\n
\n \n
\n
\n
\n
\n
\n

policy_name [required]

\n
\n

string

\n

The name of the policy.

\n
\n \n
\n
\n
\n
\n
\n

policy_type [required]

\n
\n

enum

\n

The type of the policy. Only org_config is supported, indicating a policy backed by an organization configuration setting. \nAllowed enum values: org_config

default: org_config

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group policy.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of an org group policy.

\n
\n
\n
\n
\n
\n

org_group

\n
\n

object

\n

Relationship to a single org group.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A reference to an org group.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org group policies resource type. \nAllowed enum values: org_group_policies

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

An org group policy resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an org group policy.

\n
\n
\n
\n
\n
\n

content

\n
\n

object

\n

The policy content as key-value pairs.

\n
\n \n
\n
\n
\n
\n
\n

enforcement_tier [required]

\n
\n

enum

\n

The enforcement tier of the policy. OVERRIDE_ALLOWED means the policy is set but member orgs may mutate it. GROUP_MANAGED means the policy is strictly controlled and mutations are blocked for affected orgs. DELEGATE means each member org controls its own value. \nAllowed enum values: OVERRIDE_ALLOWED,GROUP_MANAGED,DELEGATE

default: OVERRIDE_ALLOWED

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the policy was last modified.

\n
\n \n
\n
\n
\n
\n
\n

policy_name [required]

\n
\n

string

\n

The name of the policy.

\n
\n \n
\n
\n
\n
\n
\n

policy_type [required]

\n
\n

enum

\n

The type of the policy. Only org_config is supported, indicating a policy backed by an organization configuration setting. \nAllowed enum values: org_config

default: org_config

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group policy.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of an org group policy.

\n
\n
\n
\n
\n
\n

org_group

\n
\n

object

\n

Relationship to a single org group.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A reference to an org group.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org group policies resource type. \nAllowed enum values: org_group_policies

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1151,13 +1151,13 @@ "content": { "value": "UTC" }, - "enforcement_tier": "DEFAULT" + "enforcement_tier": "OVERRIDE_ALLOWED" }, "id": "1a2b3c4d-5e6f-7890-abcd-ef0123456789", "type": "org_group_policies" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for updating an org group policy.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for updating an org group policy.

\n
\n
\n
\n
\n
\n

content

\n
\n

object

\n

The policy content as key-value pairs.

\n
\n \n
\n
\n
\n
\n
\n

enforcement_tier

\n
\n

enum

\n

The enforcement tier of the policy. DEFAULT means the policy is set but member orgs may mutate it. ENFORCE means the policy is strictly controlled and mutations are blocked for affected orgs. DELEGATE means each member org controls its own value. \nAllowed enum values: DEFAULT,ENFORCE,DELEGATE

default: DEFAULT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the policy.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org group policies resource type. \nAllowed enum values: org_group_policies

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for updating an org group policy.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for updating an org group policy.

\n
\n
\n
\n
\n
\n

content

\n
\n

object

\n

The policy content as key-value pairs.

\n
\n \n
\n
\n
\n
\n
\n

enforcement_tier

\n
\n

enum

\n

The enforcement tier of the policy. OVERRIDE_ALLOWED means the policy is set but member orgs may mutate it. GROUP_MANAGED means the policy is strictly controlled and mutations are blocked for affected orgs. DELEGATE means each member org controls its own value. \nAllowed enum values: OVERRIDE_ALLOWED,GROUP_MANAGED,DELEGATE

default: OVERRIDE_ALLOWED

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the policy.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org group policies resource type. \nAllowed enum values: org_group_policies

\n
\n \n
\n
\n
\n
" } }, "ListOrgGroupPolicyConfigs": { @@ -1879,40 +1879,9 @@ "owner_org_uuid": "b2c3d4e5-f6a7-8901-bcde-f01234567890" }, "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789", - "relationships": { - "memberships": { - "data": [ - { - "id": "f1e2d3c4-b5a6-7890-1234-567890abcdef", - "type": "org_group_memberships" - } - ] - } - }, "type": "org_groups" } ], - "included": [ - { - "attributes": { - "created_at": "2024-01-15T10:30:00Z", - "modified_at": "2024-01-15T10:30:00Z", - "org_name": "Acme Corp", - "org_site": "us1", - "org_uuid": "c3d4e5f6-a7b8-9012-cdef-012345678901" - }, - "id": "f1e2d3c4-b5a6-7890-1234-567890abcdef", - "relationships": { - "org_group": { - "data": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789", - "type": "org_groups" - } - } - }, - "type": "org_group_memberships" - } - ], "links": { "first": "string", "last": "string", @@ -1933,7 +1902,7 @@ } } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of org groups.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an org group.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the org group was created.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the org group was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the org group.

\n
\n \n
\n
\n
\n
\n
\n

owner_org_site [required]

\n
\n

string

\n

The site of the organization that owns this org group.

\n
\n \n
\n
\n
\n
\n
\n

owner_org_uuid [required]

\n
\n

uuid

\n

The UUID of the organization that owns this org group.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of an org group.

\n
\n
\n
\n
\n
\n

memberships

\n
\n

object

\n

Relationship to org group memberships.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of membership relationship references.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the membership.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org group memberships resource type. \nAllowed enum values: org_group_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Related resources included in the response when requested with the include parameter.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an org group membership.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the membership was created.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the membership was last modified.

\n
\n \n
\n
\n
\n
\n
\n

org_name [required]

\n
\n

string

\n

The name of the member organization.

\n
\n \n
\n
\n
\n
\n
\n

org_site [required]

\n
\n

string

\n

The site of the member organization.

\n
\n \n
\n
\n
\n
\n
\n

org_uuid [required]

\n
\n

uuid

\n

The UUID of the member organization.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group membership.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of an org group membership.

\n
\n
\n
\n
\n
\n

org_group

\n
\n

object

\n

Relationship to a single org group.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A reference to an org group.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org group memberships resource type. \nAllowed enum values: org_group_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Pagination links for navigating between pages of an org group list response.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

Link to the first page.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Link to the last page.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Link to the next page.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Link to the previous page.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Link to the current page.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Pagination metadata for org group list responses.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Page-based pagination details for org group list responses.

\n
\n
\n
\n
\n
\n

first_number

\n
\n

int64

\n

First page number.

\n
\n \n
\n
\n
\n
\n
\n

last_number

\n
\n

int64

\n

Last page number.

\n
\n \n
\n
\n
\n
\n
\n

next_number

\n
\n

int64

\n

Next page number.

\n
\n \n
\n
\n
\n
\n
\n

number

\n
\n

int64

\n

Page number.

\n
\n \n
\n
\n
\n
\n
\n

prev_number

\n
\n

int64

\n

Previous page number.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Page size.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total number of results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Pagination type.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of org groups.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an org group.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the org group was created.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the org group was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the org group.

\n
\n \n
\n
\n
\n
\n
\n

owner_org_site [required]

\n
\n

string

\n

The site of the organization that owns this org group.

\n
\n \n
\n
\n
\n
\n
\n

owner_org_uuid [required]

\n
\n

uuid

\n

The UUID of the organization that owns this org group.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Pagination links for navigating between pages of an org group list response.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

Link to the first page.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Link to the last page.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Link to the next page.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Link to the previous page.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Link to the current page.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Pagination metadata for org group list responses.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Page-based pagination details for org group list responses.

\n
\n
\n
\n
\n
\n

first_number

\n
\n

int64

\n

First page number.

\n
\n \n
\n
\n
\n
\n
\n

last_number

\n
\n

int64

\n

Last page number.

\n
\n \n
\n
\n
\n
\n
\n

next_number

\n
\n

int64

\n

Next page number.

\n
\n \n
\n
\n
\n
\n
\n

number

\n
\n

int64

\n

Page number.

\n
\n \n
\n
\n
\n
\n
\n

prev_number

\n
\n

int64

\n

Previous page number.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Page size.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total number of results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Pagination type.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -2017,20 +1986,10 @@ "owner_org_uuid": "b2c3d4e5-f6a7-8901-bcde-f01234567890" }, "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789", - "relationships": { - "memberships": { - "data": [ - { - "id": "f1e2d3c4-b5a6-7890-1234-567890abcdef", - "type": "org_group_memberships" - } - ] - } - }, "type": "org_groups" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

An org group resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an org group.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the org group was created.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the org group was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the org group.

\n
\n \n
\n
\n
\n
\n
\n

owner_org_site [required]

\n
\n

string

\n

The site of the organization that owns this org group.

\n
\n \n
\n
\n
\n
\n
\n

owner_org_uuid [required]

\n
\n

uuid

\n

The UUID of the organization that owns this org group.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of an org group.

\n
\n
\n
\n
\n
\n

memberships

\n
\n

object

\n

Relationship to org group memberships.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of membership relationship references.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the membership.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org group memberships resource type. \nAllowed enum values: org_group_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

An org group resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an org group.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the org group was created.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the org group was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the org group.

\n
\n \n
\n
\n
\n
\n
\n

owner_org_site [required]

\n
\n

string

\n

The site of the organization that owns this org group.

\n
\n \n
\n
\n
\n
\n
\n

owner_org_uuid [required]

\n
\n

uuid

\n

The UUID of the organization that owns this org group.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -2235,20 +2194,10 @@ "owner_org_uuid": "b2c3d4e5-f6a7-8901-bcde-f01234567890" }, "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789", - "relationships": { - "memberships": { - "data": [ - { - "id": "f1e2d3c4-b5a6-7890-1234-567890abcdef", - "type": "org_group_memberships" - } - ] - } - }, "type": "org_groups" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

An org group resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an org group.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the org group was created.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the org group was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the org group.

\n
\n \n
\n
\n
\n
\n
\n

owner_org_site [required]

\n
\n

string

\n

The site of the organization that owns this org group.

\n
\n \n
\n
\n
\n
\n
\n

owner_org_uuid [required]

\n
\n

uuid

\n

The UUID of the organization that owns this org group.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of an org group.

\n
\n
\n
\n
\n
\n

memberships

\n
\n

object

\n

Relationship to org group memberships.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of membership relationship references.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the membership.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org group memberships resource type. \nAllowed enum values: org_group_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

An org group resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an org group.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the org group was created.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the org group was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the org group.

\n
\n \n
\n
\n
\n
\n
\n

owner_org_site [required]

\n
\n

string

\n

The site of the organization that owns this org group.

\n
\n \n
\n
\n
\n
\n
\n

owner_org_uuid [required]

\n
\n

uuid

\n

The UUID of the organization that owns this org group.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -2350,20 +2299,10 @@ "owner_org_uuid": "b2c3d4e5-f6a7-8901-bcde-f01234567890" }, "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789", - "relationships": { - "memberships": { - "data": [ - { - "id": "f1e2d3c4-b5a6-7890-1234-567890abcdef", - "type": "org_group_memberships" - } - ] - } - }, "type": "org_groups" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

An org group resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an org group.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the org group was created.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the org group was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the org group.

\n
\n \n
\n
\n
\n
\n
\n

owner_org_site [required]

\n
\n

string

\n

The site of the organization that owns this org group.

\n
\n \n
\n
\n
\n
\n
\n

owner_org_uuid [required]

\n
\n

uuid

\n

The UUID of the organization that owns this org group.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of an org group.

\n
\n
\n
\n
\n
\n

memberships

\n
\n

object

\n

Relationship to org group memberships.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of membership relationship references.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the membership.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org group memberships resource type. \nAllowed enum values: org_group_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

An org group resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an org group.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the org group was created.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the org group was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the org group.

\n
\n \n
\n
\n
\n
\n
\n

owner_org_site [required]

\n
\n

string

\n

The site of the organization that owns this org group.

\n
\n \n
\n
\n
\n
\n
\n

owner_org_uuid [required]

\n
\n

uuid

\n

The UUID of the organization that owns this org group.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the org group.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Org groups resource type. \nAllowed enum values: org_groups

\n
\n \n
\n
\n
\n
" }, "400": { "json": { diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index e1d950a6112..26a98d19eb7 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -1051,20 +1051,6 @@ components: example: "a1b2c3d4-e5f6-7890-abcd-ef0123456789" format: uuid type: string - OrgGroupInclude: - description: >- - List of related resources to include. - explode: false - in: query - name: include - required: false - schema: - example: - - memberships - items: - $ref: "#/components/schemas/OrgGroupIncludeOption" - type: array - style: form OrgGroupMembershipFilterOrgGroupId: description: Filter memberships by org group ID. Required when `filter[org_uuid]` is not provided. in: query @@ -59745,8 +59731,6 @@ components: example: "a1b2c3d4-e5f6-7890-abcd-ef0123456789" format: uuid type: string - relationships: - $ref: "#/components/schemas/OrgGroupRelationships" type: $ref: "#/components/schemas/OrgGroupType" required: @@ -59754,13 +59738,6 @@ components: - type - attributes type: object - OrgGroupIncludeOption: - description: Allowed include options for org group endpoints. - enum: - - memberships - type: string - x-enum-varnames: - - MEMBERSHIPS OrgGroupListResponse: description: Response containing a list of org groups. properties: @@ -59769,11 +59746,6 @@ components: items: $ref: "#/components/schemas/OrgGroupData" type: array - included: - description: Related resources included in the response when requested with the `include` parameter. - items: - $ref: "#/components/schemas/OrgGroupMembershipData" - type: array links: $ref: "#/components/schemas/OrgGroupPaginationLinks" meta: @@ -59900,20 +59872,6 @@ components: required: - data type: object - OrgGroupMembershipRelationshipData: - description: A reference to an org group membership. - properties: - id: - description: The ID of the membership. - example: "f1e2d3c4-b5a6-7890-1234-567890abcdef" - format: uuid - type: string - type: - $ref: "#/components/schemas/OrgGroupMembershipType" - required: - - id - - type - type: object OrgGroupMembershipRelationships: description: Relationships of an org group membership. properties: @@ -59984,17 +59942,6 @@ components: required: - data type: object - OrgGroupMembershipsRelationship: - description: Relationship to org group memberships. - properties: - data: - description: An array of membership relationship references. - items: - $ref: "#/components/schemas/OrgGroupMembershipRelationshipData" - type: array - required: - - data - type: object OrgGroupPaginationLinks: description: Pagination links for navigating between pages of an org group list response. properties: @@ -60228,18 +60175,18 @@ components: - attributes type: object OrgGroupPolicyEnforcementTier: - default: DEFAULT + default: OVERRIDE_ALLOWED description: >- - The enforcement tier of the policy. `DEFAULT` means the policy is set but member orgs may mutate it. `ENFORCE` means the policy is strictly controlled and mutations are blocked for affected orgs. `DELEGATE` means each member org controls its own value. + The enforcement tier of the policy. `OVERRIDE_ALLOWED` means the policy is set but member orgs may mutate it. `GROUP_MANAGED` means the policy is strictly controlled and mutations are blocked for affected orgs. `DELEGATE` means each member org controls its own value. enum: - - DEFAULT - - ENFORCE + - OVERRIDE_ALLOWED + - GROUP_MANAGED - DELEGATE - example: DEFAULT + example: OVERRIDE_ALLOWED type: string x-enum-varnames: - - DEFAULT - - ENFORCE + - OVERRIDE_ALLOWED + - GROUP_MANAGED - DELEGATE OrgGroupPolicyListResponse: description: Response containing a list of org group policies. @@ -60580,12 +60527,6 @@ components: - id - type type: object - OrgGroupRelationships: - description: Relationships of an org group. - properties: - memberships: - $ref: "#/components/schemas/OrgGroupMembershipsRelationship" - type: object OrgGroupResponse: description: Response containing a single org group. properties: @@ -134403,7 +134344,7 @@ paths: - attributes: content: value: "UTC" - enforcement_tier: "DEFAULT" + enforcement_tier: "OVERRIDE_ALLOWED" modified_at: "2024-01-15T10:30:00Z" policy_name: "monitor_timezone" policy_type: "org_config" @@ -134476,7 +134417,7 @@ paths: attributes: content: value: "UTC" - enforcement_tier: "DEFAULT" + enforcement_tier: "OVERRIDE_ALLOWED" policy_name: "monitor_timezone" policy_type: "org_config" relationships: @@ -134499,7 +134440,7 @@ paths: attributes: content: value: "UTC" - enforcement_tier: "DEFAULT" + enforcement_tier: "OVERRIDE_ALLOWED" modified_at: "2024-01-15T10:30:00Z" policy_name: "monitor_timezone" policy_type: "org_config" @@ -134610,7 +134551,7 @@ paths: attributes: content: value: "UTC" - enforcement_tier: "DEFAULT" + enforcement_tier: "OVERRIDE_ALLOWED" modified_at: "2024-01-15T10:30:00Z" policy_name: "monitor_timezone" policy_type: "org_config" @@ -134675,7 +134616,7 @@ paths: attributes: content: value: "US/Eastern" - enforcement_tier: "ENFORCE" + enforcement_tier: "GROUP_MANAGED" id: "1a2b3c4d-5e6f-7890-abcd-ef0123456789" type: org_group_policies schema: @@ -134692,7 +134633,7 @@ paths: attributes: content: value: "US/Eastern" - enforcement_tier: "ENFORCE" + enforcement_tier: "GROUP_MANAGED" modified_at: "2024-01-16T14:00:00Z" policy_name: "monitor_timezone" policy_type: "org_config" @@ -135166,7 +135107,6 @@ paths: - $ref: "#/components/parameters/OrgGroupPageNumber" - $ref: "#/components/parameters/OrgGroupPageSize" - $ref: "#/components/parameters/OrgGroupSort" - - $ref: "#/components/parameters/OrgGroupInclude" responses: "200": content: