From 95b9328f23b50851fad82eff021bcd415f6e97e4 Mon Sep 17 00:00:00 2001 From: Curtis Castrapel Date: Fri, 19 May 2023 13:42:42 -0700 Subject: [PATCH] Update schema docs --- .../3-schemas/aws_iam_group_template.json | 23 ++++++---- .../3-schemas/aws_iam_group_template.mdx | 15 ++++--- .../aws_iam_managed_policy_template.json | 21 ++++++--- .../aws_iam_managed_policy_template.mdx | 13 +++--- .../3-schemas/aws_iam_role_template.json | 44 ++++++++++++------- .../3-schemas/aws_iam_role_template.mdx | 28 +++++++----- .../3-schemas/aws_iam_user_template.json | 29 +++++++----- .../3-schemas/aws_iam_user_template.mdx | 21 +++++---- ...entity_center_permission_set_template.json | 23 +++++----- ...dentity_center_permission_set_template.mdx | 20 ++++----- .../docs/3-reference/3-schemas/awsconfig.json | 18 ++++++++ .../docs/3-reference/3-schemas/awsconfig.mdx | 3 ++ .../3-schemas/awsorganization.json | 12 +++++ .../3-reference/3-schemas/awsorganization.mdx | 2 + ...azure_active_directory_group_template.json | 9 ++-- .../azure_active_directory_group_template.mdx | 10 ++--- .../azure_active_directory_user_template.json | 6 +-- .../azure_active_directory_user_template.mdx | 6 +-- .../google_workspace_group_template.json | 4 +- .../google_workspace_group_template.mdx | 4 +- .../3-schemas/okta_app_template.json | 8 ++-- .../3-schemas/okta_app_template.mdx | 8 ++-- .../3-reference/3-schemas/okta_config.json | 2 +- .../3-reference/3-schemas/okta_config.mdx | 2 +- .../3-schemas/okta_group_template.json | 9 ++-- .../3-schemas/okta_group_template.mdx | 8 ++-- .../3-schemas/okta_user_template.json | 5 +-- .../3-schemas/okta_user_template.mdx | 4 +- 28 files changed, 221 insertions(+), 136 deletions(-) diff --git a/docs/web/docs/3-reference/3-schemas/aws_iam_group_template.json b/docs/web/docs/3-reference/3-schemas/aws_iam_group_template.json index 21f545a28..64e4e2114 100644 --- a/docs/web/docs/3-reference/3-schemas/aws_iam_group_template.json +++ b/docs/web/docs/3-reference/3-schemas/aws_iam_group_template.json @@ -62,7 +62,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -187,7 +187,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -333,7 +333,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -505,7 +505,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -561,10 +561,17 @@ "statement": { "title": "Statement", "description": "List of policy statements", - "type": "array", - "items": { - "$ref": "#/definitions/PolicyStatement" - } + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyStatement" + } + }, + { + "$ref": "#/definitions/PolicyStatement" + } + ] } }, "required": [ diff --git a/docs/web/docs/3-reference/3-schemas/aws_iam_group_template.mdx b/docs/web/docs/3-reference/3-schemas/aws_iam_group_template.mdx index bb6c73495..6c24102c8 100644 --- a/docs/web/docs/3-reference/3-schemas/aws_iam_group_template.mdx +++ b/docs/web/docs/3-reference/3-schemas/aws_iam_group_template.mdx @@ -18,7 +18,7 @@ configurations for other models used in IAMbic.* - *string* - *string* - *string* -- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. +- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`template_type`** *(string)*: Default: `"NOQ::AWS::IAM::Group"`. - **`owner`** *(string)*: Owner of the group. - **`iambic_managed`**: Controls the directionality of Iambic changes. Default: `"undefined"`. @@ -57,7 +57,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`included_accounts`** *(array)*: A list of account ids and/or account names this statement applies to. Account ids/names can be represented as a regex and string. Default: `["*"]`. - **Items** *(string)* - **`excluded_accounts`** *(array)*: A list of account ids and/or account names this statement explicitly does not apply to. Account ids/names can be represented as a regex and string. Default: `[]`. @@ -103,7 +103,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`included_accounts`** *(array)*: A list of account ids and/or account names this statement applies to. Account ids/names can be represented as a regex and string. Default: `["*"]`. - **Items** *(string)* - **`excluded_accounts`** *(array)*: A list of account ids and/or account names this statement explicitly does not apply to. Account ids/names can be represented as a regex and string. Default: `[]`. @@ -153,7 +153,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`included_accounts`** *(array)*: A list of account ids and/or account names this statement applies to. Account ids/names can be represented as a regex and string. Default: `["*"]`. - **Items** *(string)* - **`excluded_accounts`** *(array)*: A list of account ids and/or account names this statement explicitly does not apply to. Account ids/names can be represented as a regex and string. Default: `[]`. @@ -164,8 +164,11 @@ configurations for other models used in IAMbic. Cannot contain additional proper - **Items** *(string)* - **`policy_name`** *(string)*: The name of the policy. - **`version`** *(string)* - - **`statement`** *(array)*: List of policy statements. - - **Items**: Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*. + - **`statement`**: List of policy statements. + - **Any of** + - *array* + - **Items**: Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*. + - : Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*. diff --git a/docs/web/docs/3-reference/3-schemas/aws_iam_managed_policy_template.json b/docs/web/docs/3-reference/3-schemas/aws_iam_managed_policy_template.json index 525118e35..ce8498b0e 100644 --- a/docs/web/docs/3-reference/3-schemas/aws_iam_managed_policy_template.json +++ b/docs/web/docs/3-reference/3-schemas/aws_iam_managed_policy_template.json @@ -62,7 +62,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -301,7 +301,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -501,10 +501,17 @@ "statement": { "title": "Statement", "description": "List of policy statements", - "type": "array", - "items": { - "$ref": "#/definitions/PolicyStatement" - } + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyStatement" + } + }, + { + "$ref": "#/definitions/PolicyStatement" + } + ] } } }, @@ -572,7 +579,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, diff --git a/docs/web/docs/3-reference/3-schemas/aws_iam_managed_policy_template.mdx b/docs/web/docs/3-reference/3-schemas/aws_iam_managed_policy_template.mdx index 82b59abe4..62fa53d2c 100644 --- a/docs/web/docs/3-reference/3-schemas/aws_iam_managed_policy_template.mdx +++ b/docs/web/docs/3-reference/3-schemas/aws_iam_managed_policy_template.mdx @@ -18,7 +18,7 @@ configurations for other models used in IAMbic.* - *string* - *string* - *string* -- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. +- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`template_type`** *(string)*: Default: `"NOQ::AWS::IAM::ManagedPolicy"`. - **`owner`** *(string)* - **`iambic_managed`**: Controls the directionality of Iambic changes. Default: `"undefined"`. @@ -96,7 +96,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`included_accounts`** *(array)*: A list of account ids and/or account names this statement applies to. Account ids/names can be represented as a regex and string. Default: `["*"]`. - **Items** *(string)* - **`excluded_accounts`** *(array)*: A list of account ids and/or account names this statement explicitly does not apply to. Account ids/names can be represented as a regex and string. Default: `[]`. @@ -150,8 +150,11 @@ configurations for other models used in IAMbic. - **`excluded_orgs`** *(array)*: A list of AWS organization ids this statement explicitly does not apply to. Org ids can be represented as a regex and string. Default: `[]`. - **Items** *(string)* - **`version`** *(string)* - - **`statement`** *(array)*: List of policy statements. - - **Items**: Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*. + - **`statement`**: List of policy statements. + - **Any of** + - *array* + - **Items**: Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*. + - : Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*. @@ -170,7 +173,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`key`** *(string)* - **`value`** *(string)* diff --git a/docs/web/docs/3-reference/3-schemas/aws_iam_role_template.json b/docs/web/docs/3-reference/3-schemas/aws_iam_role_template.json index 965b599e0..16d7e842b 100644 --- a/docs/web/docs/3-reference/3-schemas/aws_iam_role_template.json +++ b/docs/web/docs/3-reference/3-schemas/aws_iam_role_template.json @@ -62,7 +62,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -342,7 +342,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -448,7 +448,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -648,10 +648,17 @@ }, "statement": { "title": "Statement", - "type": "array", - "items": { - "$ref": "#/definitions/PolicyStatement" - } + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyStatement" + } + }, + { + "$ref": "#/definitions/PolicyStatement" + } + ] } } }, @@ -719,7 +726,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -762,7 +769,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -845,7 +852,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -901,10 +908,17 @@ "statement": { "title": "Statement", "description": "List of policy statements", - "type": "array", - "items": { - "$ref": "#/definitions/PolicyStatement" - } + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyStatement" + } + }, + { + "$ref": "#/definitions/PolicyStatement" + } + ] } }, "required": [ @@ -1094,7 +1108,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, diff --git a/docs/web/docs/3-reference/3-schemas/aws_iam_role_template.mdx b/docs/web/docs/3-reference/3-schemas/aws_iam_role_template.mdx index 02b6cecac..e14d3bf1f 100644 --- a/docs/web/docs/3-reference/3-schemas/aws_iam_role_template.mdx +++ b/docs/web/docs/3-reference/3-schemas/aws_iam_role_template.mdx @@ -18,7 +18,7 @@ configurations for other models used in IAMbic.* - *string* - *string* - *string* -- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. +- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`template_type`** *(string)*: Default: `"NOQ::AWS::IAM::Role"`. - **`owner`** *(string)*: Owner of the role. - **`iambic_managed`**: Controls the directionality of Iambic changes. Default: `"undefined"`. @@ -95,7 +95,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`policy_arn`** *(string)* - **`permissions_boundary_type`** *(string)* @@ -133,7 +133,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`included_accounts`** *(array)*: A list of account ids and/or account names this statement applies to. Account ids/names can be represented as a regex and string. Default: `["*"]`. - **Items** *(string)* - **`excluded_accounts`** *(array)*: A list of account ids and/or account names this statement explicitly does not apply to. Account ids/names can be represented as a regex and string. Default: `[]`. @@ -187,8 +187,11 @@ configurations for other models used in IAMbic. - **`excluded_orgs`** *(array)*: A list of AWS organization ids this statement explicitly does not apply to. Org ids can be represented as a regex and string. Default: `[]`. - **Items** *(string)* - **`version`** *(string)*: Default: `"2008-10-17"`. - - **`statement`** *(array)* - - **Items**: Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*. + - **`statement`** + - **Any of** + - *array* + - **Items**: Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*. + - : Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*. @@ -207,7 +210,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`key`** *(string)* - **`value`** *(string)* @@ -220,7 +223,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`included_accounts`** *(array)*: A list of account ids and/or account names this statement applies to. Account ids/names can be represented as a regex and string. Default: `["*"]`. - **Items** *(string)* - **`excluded_accounts`** *(array)*: A list of account ids and/or account names this statement explicitly does not apply to. Account ids/names can be represented as a regex and string. Default: `[]`. @@ -241,7 +244,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`included_accounts`** *(array)*: A list of account ids and/or account names this statement applies to. Account ids/names can be represented as a regex and string. Default: `["*"]`. - **Items** *(string)* - **`excluded_accounts`** *(array)*: A list of account ids and/or account names this statement explicitly does not apply to. Account ids/names can be represented as a regex and string. Default: `[]`. @@ -252,8 +255,11 @@ configurations for other models used in IAMbic. Cannot contain additional proper - **Items** *(string)* - **`policy_name`** *(string)*: The name of the policy. - **`version`** *(string)* - - **`statement`** *(array)*: List of policy statements. - - **Items**: Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*. + - **`statement`**: List of policy statements. + - **Any of** + - *array* + - **Items**: Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*. + - : Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*. @@ -309,7 +315,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`users`** *(array)*: List of users who can assume into the role. Default: `[]`. - **Items** *(string)* - **`groups`** *(array)*: List of groups. Users in one or more of the groups can assume into the role. Default: `[]`. diff --git a/docs/web/docs/3-reference/3-schemas/aws_iam_user_template.json b/docs/web/docs/3-reference/3-schemas/aws_iam_user_template.json index 27a84699e..eb3361a18 100644 --- a/docs/web/docs/3-reference/3-schemas/aws_iam_user_template.json +++ b/docs/web/docs/3-reference/3-schemas/aws_iam_user_template.json @@ -62,7 +62,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -226,7 +226,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -309,7 +309,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -392,7 +392,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -458,7 +458,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -604,7 +604,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -776,7 +776,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -832,10 +832,17 @@ "statement": { "title": "Statement", "description": "List of policy statements", - "type": "array", - "items": { - "$ref": "#/definitions/PolicyStatement" - } + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyStatement" + } + }, + { + "$ref": "#/definitions/PolicyStatement" + } + ] } }, "required": [ diff --git a/docs/web/docs/3-reference/3-schemas/aws_iam_user_template.mdx b/docs/web/docs/3-reference/3-schemas/aws_iam_user_template.mdx index a22a4a2be..f090600bd 100644 --- a/docs/web/docs/3-reference/3-schemas/aws_iam_user_template.mdx +++ b/docs/web/docs/3-reference/3-schemas/aws_iam_user_template.mdx @@ -18,7 +18,7 @@ configurations for other models used in IAMbic.* - *string* - *string* - *string* -- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. +- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`template_type`** *(string)*: Default: `"NOQ::AWS::IAM::User"`. - **`owner`** *(string)* - **`iambic_managed`**: Controls the directionality of Iambic changes. Default: `"undefined"`. @@ -65,7 +65,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`policy_arn`** *(string)* - **`permissions_boundary_type`** *(string)* @@ -86,7 +86,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`key`** *(string)* - **`value`** *(string)* @@ -107,7 +107,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`group_name`** *(string)* - **`arn`** *(string)*: ARN of the group. Default: `""`. - **`create_date`** *(string)*: Date the group was created. Default: `""`. @@ -124,7 +124,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`included_accounts`** *(array)*: A list of account ids and/or account names this statement applies to. Account ids/names can be represented as a regex and string. Default: `["*"]`. - **Items** *(string)* - **`excluded_accounts`** *(array)*: A list of account ids and/or account names this statement explicitly does not apply to. Account ids/names can be represented as a regex and string. Default: `[]`. @@ -170,7 +170,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`included_accounts`** *(array)*: A list of account ids and/or account names this statement applies to. Account ids/names can be represented as a regex and string. Default: `["*"]`. - **Items** *(string)* - **`excluded_accounts`** *(array)*: A list of account ids and/or account names this statement explicitly does not apply to. Account ids/names can be represented as a regex and string. Default: `[]`. @@ -220,7 +220,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`included_accounts`** *(array)*: A list of account ids and/or account names this statement applies to. Account ids/names can be represented as a regex and string. Default: `["*"]`. - **Items** *(string)* - **`excluded_accounts`** *(array)*: A list of account ids and/or account names this statement explicitly does not apply to. Account ids/names can be represented as a regex and string. Default: `[]`. @@ -231,8 +231,11 @@ configurations for other models used in IAMbic. Cannot contain additional proper - **Items** *(string)* - **`policy_name`** *(string)*: The name of the policy. - **`version`** *(string)* - - **`statement`** *(array)*: List of policy statements. - - **Items**: Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*. + - **`statement`**: List of policy statements. + - **Any of** + - *array* + - **Items**: Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*. + - : Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*. diff --git a/docs/web/docs/3-reference/3-schemas/aws_identity_center_permission_set_template.json b/docs/web/docs/3-reference/3-schemas/aws_identity_center_permission_set_template.json index 62fa729a4..19c4147b4 100644 --- a/docs/web/docs/3-reference/3-schemas/aws_identity_center_permission_set_template.json +++ b/docs/web/docs/3-reference/3-schemas/aws_identity_center_permission_set_template.json @@ -22,7 +22,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -188,12 +188,14 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, "path": { "title": "Path", + "description": "The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is /. For more information, see Friendly names and paths in the IAM User Guide.", + "default": "/", "type": "string" }, "name": { @@ -202,7 +204,6 @@ } }, "required": [ - "path", "name" ], "additionalProperties": false @@ -231,15 +232,15 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, "customer_managed_policy_reference": { "$ref": "#/definitions/CustomerManagedPolicyReference" }, - "policy_arn": { - "title": "Policyarn", + "managed_policy_arn": { + "title": "Managedpolicyarn", "type": "string" } }, @@ -332,7 +333,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -504,7 +505,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -547,7 +548,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -625,7 +626,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -745,7 +746,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, diff --git a/docs/web/docs/3-reference/3-schemas/aws_identity_center_permission_set_template.mdx b/docs/web/docs/3-reference/3-schemas/aws_identity_center_permission_set_template.mdx index 03d92357e..5c302a890 100644 --- a/docs/web/docs/3-reference/3-schemas/aws_identity_center_permission_set_template.mdx +++ b/docs/web/docs/3-reference/3-schemas/aws_identity_center_permission_set_template.mdx @@ -10,7 +10,7 @@ configurations for other models used in IAMbic.* - *string* - *string* - *string* -- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. +- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`template_type`** *(string)*: Default: `"NOQ::AWS::IdentityCenter::PermissionSet"`. - **`owner`** *(string)*: Owner of the permission set. - **`iambic_managed`**: Controls the directionality of Iambic changes. Default: `"undefined"`. @@ -60,8 +60,8 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. - - **`path`** *(string)* + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. + - **`path`** *(string)*: The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is /. For more information, see Friendly names and paths in the IAM User Guide. Default: `"/"`. - **`name`** *(string)* @@ -73,9 +73,9 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`customer_managed_policy_reference`**: Refer to *[#/definitions/CustomerManagedPolicyReference](#definitions/CustomerManagedPolicyReference)*. - - **`policy_arn`** *(string)* + - **`managed_policy_arn`** *(string)* @@ -111,7 +111,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`included_accounts`** *(array)*: A list of account ids and/or account names this statement applies to. Account ids/names can be represented as a regex and string. Default: `["*"]`. - **Items** *(string)* - **`excluded_accounts`** *(array)*: A list of account ids and/or account names this statement explicitly does not apply to. Account ids/names can be represented as a regex and string. Default: `[]`. @@ -161,7 +161,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`version`** *(string)* - **`statement`** *(array)*: List of policy statements. - **Items**: Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*. @@ -175,7 +175,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`arn`** *(string)* @@ -195,7 +195,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`key`** *(string)* - **`value`** *(string)* @@ -233,7 +233,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`included_accounts`** *(array)*: A list of account ids and/or account names this statement applies to. Account ids/names can be represented as a regex and string. Default: `["*"]`. - **Items** *(string)* - **`excluded_accounts`** *(array)*: A list of account ids and/or account names this statement explicitly does not apply to. Account ids/names can be represented as a regex and string. Default: `[]`. diff --git a/docs/web/docs/3-reference/3-schemas/awsconfig.json b/docs/web/docs/3-reference/3-schemas/awsconfig.json index 0facb0e84..afa857c6a 100644 --- a/docs/web/docs/3-reference/3-schemas/awsconfig.json +++ b/docs/web/docs/3-reference/3-schemas/awsconfig.json @@ -33,6 +33,12 @@ "items": { "type": "string" } + }, + "spoke_role_is_read_only": { + "title": "Spoke Role Is Read Only", + "description": "aws iambic spoke role is configured as read_only. If true, it will restrict IAMbic capability in AWS", + "default": false, + "type": "boolean" } }, "definitions": { @@ -210,6 +216,18 @@ "items": { "$ref": "#/definitions/AWSOrgAccountRule" } + }, + "spoke_role_is_read_only": { + "title": "Spoke Role Is Read Only", + "description": "if true, the spoke role will be limited to read-only permissions", + "default": false, + "type": "boolean" + }, + "preferred_spoke_role_name": { + "title": "Preferred Spoke Role Name", + "description": "SpokeRoleName use across organization", + "default": "IambicSpokeRoleCurtis", + "type": "string" } }, "required": [ diff --git a/docs/web/docs/3-reference/3-schemas/awsconfig.mdx b/docs/web/docs/3-reference/3-schemas/awsconfig.mdx index 65bfe89fc..66458296c 100644 --- a/docs/web/docs/3-reference/3-schemas/awsconfig.mdx +++ b/docs/web/docs/3-reference/3-schemas/awsconfig.mdx @@ -9,6 +9,7 @@ - **`min_accounts_required_for_wildcard_included_accounts`** *(integer)*: Iambic will set included_accounts = * on imported resources that exist on all accounts if the minimum number of accounts is met. Default: `3`. - **`sqs_cloudtrail_changes_queues`** *(array)*: Default: `[]`. - **Items** *(string)* +- **`spoke_role_is_read_only`** *(boolean)*: aws iambic spoke role is configured as read_only. If true, it will restrict IAMbic capability in AWS. Default: `false`. ## Definitions @@ -68,6 +69,8 @@ configurations for other models used in IAMbic. - : Refer to *[#/definitions/BaseAWSOrgRule](#definitions/BaseAWSOrgRule)*. - **`account_rules`** *(array)*: A list of rules used to determine how organization accounts are handled. Default: `[]`. - **Items**: Refer to *[#/definitions/AWSOrgAccountRule](#definitions/AWSOrgAccountRule)*. + - **`spoke_role_is_read_only`** *(boolean)*: if true, the spoke role will be limited to read-only permissions. Default: `false`. + - **`preferred_spoke_role_name`** *(string)*: SpokeRoleName use across organization. Default: `"IambicSpokeRoleCurtis"`. diff --git a/docs/web/docs/3-reference/3-schemas/awsorganization.json b/docs/web/docs/3-reference/3-schemas/awsorganization.json index 75b617d69..708264cf6 100644 --- a/docs/web/docs/3-reference/3-schemas/awsorganization.json +++ b/docs/web/docs/3-reference/3-schemas/awsorganization.json @@ -77,6 +77,18 @@ "items": { "$ref": "#/definitions/AWSOrgAccountRule" } + }, + "spoke_role_is_read_only": { + "title": "Spoke Role Is Read Only", + "description": "if true, the spoke role will be limited to read-only permissions", + "default": false, + "type": "boolean" + }, + "preferred_spoke_role_name": { + "title": "Preferred Spoke Role Name", + "description": "SpokeRoleName use across organization", + "default": "IambicSpokeRoleCurtis", + "type": "string" } }, "required": [ diff --git a/docs/web/docs/3-reference/3-schemas/awsorganization.mdx b/docs/web/docs/3-reference/3-schemas/awsorganization.mdx index b476cc005..9858620b6 100644 --- a/docs/web/docs/3-reference/3-schemas/awsorganization.mdx +++ b/docs/web/docs/3-reference/3-schemas/awsorganization.mdx @@ -20,6 +20,8 @@ - : Refer to *[#/definitions/BaseAWSOrgRule](#definitions/BaseAWSOrgRule)*. - **`account_rules`** *(array)*: A list of rules used to determine how organization accounts are handled. Default: `[]`. - **Items**: Refer to *[#/definitions/AWSOrgAccountRule](#definitions/AWSOrgAccountRule)*. +- **`spoke_role_is_read_only`** *(boolean)*: if true, the spoke role will be limited to read-only permissions. Default: `false`. +- **`preferred_spoke_role_name`** *(string)*: SpokeRoleName use across organization. Default: `"IambicSpokeRoleCurtis"`. ## Definitions diff --git a/docs/web/docs/3-reference/3-schemas/azure_active_directory_group_template.json b/docs/web/docs/3-reference/3-schemas/azure_active_directory_group_template.json index 9b5ecb95f..e766058e7 100644 --- a/docs/web/docs/3-reference/3-schemas/azure_active_directory_group_template.json +++ b/docs/web/docs/3-reference/3-schemas/azure_active_directory_group_template.json @@ -46,7 +46,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -109,12 +109,13 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, "id": { "title": "Id", + "description": "Unique ID for the member. This value is imported by IAMbic, and doesn't need to be manually set.", "type": "string" }, "name": { @@ -155,7 +156,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -173,7 +174,7 @@ }, "group_id": { "title": "Groupid", - "description": "Unique Group ID for the group. Usually it's {idp-name}-{name}", + "description": "Unique Group ID for the group. This value is imported by IAMbic, and doesn't need to be manually set.", "type": "string" }, "description": { diff --git a/docs/web/docs/3-reference/3-schemas/azure_active_directory_group_template.mdx b/docs/web/docs/3-reference/3-schemas/azure_active_directory_group_template.mdx index a6506d4ea..9572a9ee2 100644 --- a/docs/web/docs/3-reference/3-schemas/azure_active_directory_group_template.mdx +++ b/docs/web/docs/3-reference/3-schemas/azure_active_directory_group_template.mdx @@ -16,7 +16,7 @@ configurations for other models used in IAMbic.* - *string* - *string* - *string* -- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. +- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`properties`**: Properties for the Azure AD Group. - **All of** - : Refer to *[#/definitions/GroupTemplateProperties](#definitions/GroupTemplateProperties)*. @@ -40,8 +40,8 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. - - **`id`** *(string)* + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. + - **`id`** *(string)*: Unique ID for the member. This value is imported by IAMbic, and doesn't need to be manually set. - **`name`** *(string)* - **`data_type`**: Refer to *[#/definitions/MemberDataType](#definitions/MemberDataType)*. @@ -54,10 +54,10 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`name`** *(string)*: Name of the group. - **`mail_nickname`** *(string)*: Mail nickname of the group. - - **`group_id`** *(string)*: Unique Group ID for the group. Usually it's {idp-name}-{name}. + - **`group_id`** *(string)*: Unique Group ID for the group. This value is imported by IAMbic, and doesn't need to be manually set. - **`description`** *(string)*: Description of the group. Default: `""`. - **`group_types`** *(array)*: Specifies the group type and its membership. Default: `[]`. - **Items** *(string)* diff --git a/docs/web/docs/3-reference/3-schemas/azure_active_directory_user_template.json b/docs/web/docs/3-reference/3-schemas/azure_active_directory_user_template.json index 3610fd628..a0aaa1c36 100644 --- a/docs/web/docs/3-reference/3-schemas/azure_active_directory_user_template.json +++ b/docs/web/docs/3-reference/3-schemas/azure_active_directory_user_template.json @@ -45,7 +45,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -109,13 +109,13 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, "user_id": { "title": "Userid", - "description": "Unique identifier for the user", + "description": "Unique identifier for the user. This value is imported by IAMbic, and doesn't need to be manually set.", "default": "", "type": "string" }, diff --git a/docs/web/docs/3-reference/3-schemas/azure_active_directory_user_template.mdx b/docs/web/docs/3-reference/3-schemas/azure_active_directory_user_template.mdx index 2953d7594..d42e54905 100644 --- a/docs/web/docs/3-reference/3-schemas/azure_active_directory_user_template.mdx +++ b/docs/web/docs/3-reference/3-schemas/azure_active_directory_user_template.mdx @@ -16,7 +16,7 @@ configurations for other models used in IAMbic.* - *string* - *string* - *string* -- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. +- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`properties`**: Properties for the Azure AD User. - **All of** - : Refer to *[#/definitions/UserTemplateProperties](#definitions/UserTemplateProperties)*. @@ -40,8 +40,8 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. - - **`user_id`** *(string)*: Unique identifier for the user. Default: `""`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. + - **`user_id`** *(string)*: Unique identifier for the user. This value is imported by IAMbic, and doesn't need to be manually set. Default: `""`. - **`username`** *(string)* - **`display_name`** *(string)* - **`mail_nickname`** *(string)* diff --git a/docs/web/docs/3-reference/3-schemas/google_workspace_group_template.json b/docs/web/docs/3-reference/3-schemas/google_workspace_group_template.json index c22255e94..5a1fc1c57 100644 --- a/docs/web/docs/3-reference/3-schemas/google_workspace_group_template.json +++ b/docs/web/docs/3-reference/3-schemas/google_workspace_group_template.json @@ -22,7 +22,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -127,7 +127,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, diff --git a/docs/web/docs/3-reference/3-schemas/google_workspace_group_template.mdx b/docs/web/docs/3-reference/3-schemas/google_workspace_group_template.mdx index 8f6a5ade7..af69b5840 100644 --- a/docs/web/docs/3-reference/3-schemas/google_workspace_group_template.mdx +++ b/docs/web/docs/3-reference/3-schemas/google_workspace_group_template.mdx @@ -10,7 +10,7 @@ configurations for other models used in IAMbic.* - *string* - *string* - *string* -- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. +- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`template_type`** *(string)*: Default: `"NOQ::GoogleWorkspace::Group"`. - **`owner`** *(string)*: Owner of the group. - **`iambic_managed`**: Controls the directionality of Iambic changes. Default: `"undefined"`. @@ -49,7 +49,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`email`** *(string)* - **`expand`** *(boolean)*: Expand the group into the members of the group. This is useful for nested groups. Default: `false`. - **`role`**: Default: `"MEMBER"`. diff --git a/docs/web/docs/3-reference/3-schemas/okta_app_template.json b/docs/web/docs/3-reference/3-schemas/okta_app_template.json index 8b40b6e01..4b96cd72f 100644 --- a/docs/web/docs/3-reference/3-schemas/okta_app_template.json +++ b/docs/web/docs/3-reference/3-schemas/okta_app_template.json @@ -22,7 +22,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -109,7 +109,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -150,7 +150,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -169,7 +169,7 @@ }, "id": { "title": "Id", - "description": "Unique App ID for the app. Usually it's {idp-name}-{name}", + "description": "Unique ID for the app. This value is imported by IAMbic, and doesn't need to be manually set.", "type": "string" }, "description": { diff --git a/docs/web/docs/3-reference/3-schemas/okta_app_template.mdx b/docs/web/docs/3-reference/3-schemas/okta_app_template.mdx index 4ca5c8981..33f29b39e 100644 --- a/docs/web/docs/3-reference/3-schemas/okta_app_template.mdx +++ b/docs/web/docs/3-reference/3-schemas/okta_app_template.mdx @@ -10,7 +10,7 @@ configurations for other models used in IAMbic.* - *string* - *string* - *string* -- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. +- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`template_type`** *(string)*: Default: `"NOQ::Okta::App"`. - **`owner`** *(string)*: Owner of the app. - **`iambic_managed`**: Controls the directionality of Iambic changes. Default: `"undefined"`. @@ -40,7 +40,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`user`** *(string)*: User assigned to the app. - **`group`** *(string)*: Group assigned to the app. @@ -53,12 +53,12 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`name`** *(string)*: Name of the app. - **`status`**: Status of the app. - **All of** - : Refer to *[#/definitions/Status](#definitions/Status)*. - - **`id`** *(string)*: Unique App ID for the app. Usually it's {idp-name}-{name}. + - **`id`** *(string)*: Unique ID for the app. This value is imported by IAMbic, and doesn't need to be manually set. - **`description`** *(string)*: Description of the app. Default: `""`. - **`extra`**: Extra attributes to store. - **`created`** *(string)*: Date the app was created. Default: `""`. diff --git a/docs/web/docs/3-reference/3-schemas/okta_config.json b/docs/web/docs/3-reference/3-schemas/okta_config.json index 82030b8b9..bfbf023c1 100644 --- a/docs/web/docs/3-reference/3-schemas/okta_config.json +++ b/docs/web/docs/3-reference/3-schemas/okta_config.json @@ -54,7 +54,7 @@ }, "iambic_managed": { "description": "Controls the directionality of iambic changes", - "default": "import_only", + "default": "undefined", "allOf": [ { "$ref": "#/definitions/IambicManaged" diff --git a/docs/web/docs/3-reference/3-schemas/okta_config.mdx b/docs/web/docs/3-reference/3-schemas/okta_config.mdx index 3d5298262..a770ceff3 100644 --- a/docs/web/docs/3-reference/3-schemas/okta_config.mdx +++ b/docs/web/docs/3-reference/3-schemas/okta_config.mdx @@ -19,6 +19,6 @@ - **`api_token`** *(string)* - **`request_timeout`** *(integer)*: Default: `60`. - **`client`** - - **`iambic_managed`**: Controls the directionality of iambic changes. Default: `"import_only"`. + - **`iambic_managed`**: Controls the directionality of iambic changes. Default: `"undefined"`. - **All of** - : Refer to *[#/definitions/IambicManaged](#definitions/IambicManaged)*. diff --git a/docs/web/docs/3-reference/3-schemas/okta_group_template.json b/docs/web/docs/3-reference/3-schemas/okta_group_template.json index 367fbfa4e..9c67b8afc 100644 --- a/docs/web/docs/3-reference/3-schemas/okta_group_template.json +++ b/docs/web/docs/3-reference/3-schemas/okta_group_template.json @@ -22,7 +22,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -115,7 +115,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -213,7 +213,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -224,8 +224,7 @@ }, "group_id": { "title": "Groupid", - "description": "Unique Group ID for the group. Usually it's {idp-name}-{name}", - "default": "", + "description": "Unique Group ID for the group. This value is imported by IAMbic, and doesn't need to be manually set.", "type": "string" }, "description": { diff --git a/docs/web/docs/3-reference/3-schemas/okta_group_template.mdx b/docs/web/docs/3-reference/3-schemas/okta_group_template.mdx index 9b8bcbfda..976407004 100644 --- a/docs/web/docs/3-reference/3-schemas/okta_group_template.mdx +++ b/docs/web/docs/3-reference/3-schemas/okta_group_template.mdx @@ -10,7 +10,7 @@ configurations for other models used in IAMbic.* - *string* - *string* - *string* -- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. +- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`template_type`** *(string)*: Default: `"NOQ::Okta::Group"`. - **`owner`** *(string)*: Owner of the group. - **`iambic_managed`**: Controls the directionality of Iambic changes. Default: `"undefined"`. @@ -40,7 +40,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`username`** *(string)* - **`status`**: Status for the group. - **All of** @@ -66,9 +66,9 @@ configurations for other models used in IAMbic. Cannot contain additional proper - *string* - *string* - *string* - - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. + - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`name`** *(string)*: Name of the group. - - **`group_id`** *(string)*: Unique Group ID for the group. Usually it's {idp-name}-{name}. Default: `""`. + - **`group_id`** *(string)*: Unique Group ID for the group. This value is imported by IAMbic, and doesn't need to be manually set. - **`description`** *(string)*: Description of the group. Default: `""`. - **`extra`**: Extra attributes to store. - **`members`** *(array)*: Users in the group. Default: `[]`. diff --git a/docs/web/docs/3-reference/3-schemas/okta_user_template.json b/docs/web/docs/3-reference/3-schemas/okta_user_template.json index c37114a56..9db967dd7 100644 --- a/docs/web/docs/3-reference/3-schemas/okta_user_template.json +++ b/docs/web/docs/3-reference/3-schemas/okta_user_template.json @@ -22,7 +22,7 @@ }, "deleted": { "title": "Deleted", - "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.", + "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.", "default": false, "type": "boolean" }, @@ -102,8 +102,7 @@ }, "user_id": { "title": "Userid", - "description": "Unique User ID for the user", - "default": "", + "description": "Unique User ID for the user. This value is imported by IAMbic, and doesn't need to be manually set.", "type": "string" }, "status": { diff --git a/docs/web/docs/3-reference/3-schemas/okta_user_template.mdx b/docs/web/docs/3-reference/3-schemas/okta_user_template.mdx index b7db9c937..e09c028fa 100644 --- a/docs/web/docs/3-reference/3-schemas/okta_user_template.mdx +++ b/docs/web/docs/3-reference/3-schemas/okta_user_template.mdx @@ -10,7 +10,7 @@ configurations for other models used in IAMbic.* - *string* - *string* - *string* -- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`. +- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`. - **`template_type`** *(string)*: Default: `"NOQ::Okta::User"`. - **`owner`** *(string)* - **`iambic_managed`**: Controls the directionality of Iambic changes. Default: `"undefined"`. @@ -35,7 +35,7 @@ configurations for other models used in IAMbic.* - **`UserProperties`** *(object)*: A base model class that provides additional helper methods and configurations for other models used in IAMbic. - **`username`** *(string)*: Username of the user. - - **`user_id`** *(string)*: Unique User ID for the user. Default: `""`. + - **`user_id`** *(string)*: Unique User ID for the user. This value is imported by IAMbic, and doesn't need to be manually set. - **`status`**: Status of the user. Default: `"active"`. - **All of** - : Refer to *[#/definitions/UserStatus](#definitions/UserStatus)*.