From 1e0941c09a7ce81b2868c5540810e9818b1f9bc1 Mon Sep 17 00:00:00 2001 From: colin-mckibben-sp Date: Thu, 15 Sep 2022 16:17:26 -0400 Subject: [PATCH] Renamed CLI and Connector commands in SaaS connectivity to be less ambiguous --- ...ommon-commands.md => common-cli-commands.md} | 16 ++++++++-------- .../account-create.md | 2 +- .../account-delete.md | 2 +- .../account-discover.md | 2 +- .../account-enable.md | 2 +- .../account-list.md | 2 +- .../account-read.md | 2 +- .../account-unlock.md | 2 +- .../account-update.md | 2 +- .../entitlement-list.md | 2 +- .../entitlement-read.md | 2 +- .../img/account_create_idn.png | Bin .../img/account_list_idn.png | Bin .../img/account_read_idn.png | Bin .../img/create_password_idn.png | Bin .../img/discover_schema_idn1.png | Bin .../img/discover_schema_idn2.png | Bin .../img/discover_schema_idn3.png | Bin .../img/discover_schema_idn4.png | Bin .../img/entitlement_list_idn.png | Bin .../img/test_command_idn.png | Bin .../img/testing1.png | Bin .../img/testing2.png | Bin .../img/testing3.png | Bin .../{commands => connector-commands}/index.md | 13 ++++++------- .../test-connection.md | 2 +- 26 files changed, 25 insertions(+), 26 deletions(-) rename products/idn/docs/identity-now/saas-connectivity/{common-commands.md => common-cli-commands.md} (77%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/account-create.md (99%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/account-delete.md (97%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/account-discover.md (99%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/account-enable.md (98%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/account-list.md (99%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/account-read.md (98%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/account-unlock.md (97%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/account-update.md (99%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/entitlement-list.md (98%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/entitlement-read.md (97%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/img/account_create_idn.png (100%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/img/account_list_idn.png (100%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/img/account_read_idn.png (100%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/img/create_password_idn.png (100%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/img/discover_schema_idn1.png (100%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/img/discover_schema_idn2.png (100%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/img/discover_schema_idn3.png (100%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/img/discover_schema_idn4.png (100%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/img/entitlement_list_idn.png (100%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/img/test_command_idn.png (100%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/img/testing1.png (100%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/img/testing2.png (100%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/img/testing3.png (100%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/index.md (68%) rename products/idn/docs/identity-now/saas-connectivity/{commands => connector-commands}/test-connection.md (98%) diff --git a/products/idn/docs/identity-now/saas-connectivity/common-commands.md b/products/idn/docs/identity-now/saas-connectivity/common-cli-commands.md similarity index 77% rename from products/idn/docs/identity-now/saas-connectivity/common-commands.md rename to products/idn/docs/identity-now/saas-connectivity/common-cli-commands.md index dc71e24c2..74df962fb 100644 --- a/products/idn/docs/identity-now/saas-connectivity/common-commands.md +++ b/products/idn/docs/identity-now/saas-connectivity/common-cli-commands.md @@ -1,13 +1,13 @@ --- -id: common-commands -title: Common Commands -pagination_label: Common Commands -sidebar_label: Common Commands +id: common-cli-commands +title: Common CLI Commands +pagination_label: Common CLI Commands +sidebar_label: Common CLI Commands sidebar_position: 3 -sidebar_class_name: commonCommands -keywords: ["connectivity", "connectors", "commands"] -description: These are the commands most commonly used when building SaaS Connectors. -slug: /docs/saas-connectivity/common-commands +sidebar_class_name: commonCliCommands +keywords: ["connectivity", "connectors", "commands", "cli"] +description: These are the CLI commands most commonly used when building SaaS Connectors. +slug: /docs/saas-connectivity/common-cli-commands tags: ["Connectivity"] --- diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/account-create.md b/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-create.md similarity index 99% rename from products/idn/docs/identity-now/saas-connectivity/commands/account-create.md rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/account-create.md index 19900987c..999349d50 100644 --- a/products/idn/docs/identity-now/saas-connectivity/commands/account-create.md +++ b/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-create.md @@ -6,7 +6,7 @@ sidebar_label: Account Create keywords: ["connectivity", "connectors", "account create"] description: Create account on the source. slug: /docs/saas-connectivity/commands/account-create -tags: ["Connectivity"] +tags: ["Connectivity", "Connector Command"] --- | Input/Output | Data Type | diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/account-delete.md b/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-delete.md similarity index 97% rename from products/idn/docs/identity-now/saas-connectivity/commands/account-delete.md rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/account-delete.md index 424969878..47bc7828b 100644 --- a/products/idn/docs/identity-now/saas-connectivity/commands/account-delete.md +++ b/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-delete.md @@ -6,7 +6,7 @@ sidebar_label: Account Delete keywords: ["connectivity", "connectors", "account delete"] description: Remove account from a source. slug: /docs/saas-connectivity/commands/account-delete -tags: ["Connectivity"] +tags: ["Connectivity", "Connector Command"] --- | Input/Output | Data Type | diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/account-discover.md b/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-discover.md similarity index 99% rename from products/idn/docs/identity-now/saas-connectivity/commands/account-discover.md rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/account-discover.md index d4f7f12d9..a4a113784 100644 --- a/products/idn/docs/identity-now/saas-connectivity/commands/account-discover.md +++ b/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-discover.md @@ -6,7 +6,7 @@ sidebar_label: Account Discover keywords: ["connectivity", "connectors", "account discover"] description: Dynamically determine account schema from the source. slug: /docs/saas-connectivity/commands/account-discover -tags: ["Connectivity"] +tags: ["Connectivity", "Connector Command"] --- | Input/Output | Data Type | diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/account-enable.md b/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-enable.md similarity index 98% rename from products/idn/docs/identity-now/saas-connectivity/commands/account-enable.md rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/account-enable.md index 6f06267f1..a925be997 100644 --- a/products/idn/docs/identity-now/saas-connectivity/commands/account-enable.md +++ b/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-enable.md @@ -6,7 +6,7 @@ sidebar_label: Account Enable keywords: ["connectivity", "connectors", "account enable"] description: Enable an account on the source. slug: /docs/saas-connectivity/commands/account-enable -tags: ["Connectivity"] +tags: ["Connectivity", "Connector Command"] --- | Input/Output | Data Type | diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/account-list.md b/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-list.md similarity index 99% rename from products/idn/docs/identity-now/saas-connectivity/commands/account-list.md rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/account-list.md index e29ad1914..0d0c170f9 100644 --- a/products/idn/docs/identity-now/saas-connectivity/commands/account-list.md +++ b/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-list.md @@ -6,7 +6,7 @@ sidebar_label: Account List keywords: ["connectivity", "connectors", "account list"] description: Aggregate all accounts from the source into IdentityNow. slug: /docs/saas-connectivity/commands/account-list -tags: ["Connectivity"] +tags: ["Connectivity", "Connector Command"] --- | Input/Output | Data Type | diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/account-read.md b/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-read.md similarity index 98% rename from products/idn/docs/identity-now/saas-connectivity/commands/account-read.md rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/account-read.md index 074850987..e248df9bf 100644 --- a/products/idn/docs/identity-now/saas-connectivity/commands/account-read.md +++ b/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-read.md @@ -6,7 +6,7 @@ sidebar_label: Account Read keywords: ["connectivity", "connectors", "account read"] description: Aggregate a single account from the source into IdentityNow. slug: /docs/saas-connectivity/commands/account-read -tags: ["Connectivity"] +tags: ["Connectivity", "Connector Command"] --- | Input/Output | Data Type | diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/account-unlock.md b/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-unlock.md similarity index 97% rename from products/idn/docs/identity-now/saas-connectivity/commands/account-unlock.md rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/account-unlock.md index e8cf0b031..27b2b9170 100644 --- a/products/idn/docs/identity-now/saas-connectivity/commands/account-unlock.md +++ b/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-unlock.md @@ -6,7 +6,7 @@ sidebar_label: Account Unlock keywords: ["connectivity", "connectors", "account unlock"] description: Lock and unlock an account on the source. slug: /docs/saas-connectivity/commands/account-unlock -tags: ["Connectivity"] +tags: ["Connectivity", "Connector Command"] --- | Input/Output | Data Type | diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/account-update.md b/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-update.md similarity index 99% rename from products/idn/docs/identity-now/saas-connectivity/commands/account-update.md rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/account-update.md index 5974b89ab..3f9df13de 100644 --- a/products/idn/docs/identity-now/saas-connectivity/commands/account-update.md +++ b/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-update.md @@ -6,7 +6,7 @@ sidebar_label: Account Update keywords: ["connectivity", "connectors", "account update"] description: Update an account on the source. slug: /docs/saas-connectivity/commands/account-update -tags: ["Connectivity"] +tags: ["Connectivity", "Connector Command"] --- | Input/Output | Data Type | diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/entitlement-list.md b/products/idn/docs/identity-now/saas-connectivity/connector-commands/entitlement-list.md similarity index 98% rename from products/idn/docs/identity-now/saas-connectivity/commands/entitlement-list.md rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/entitlement-list.md index 3036a7e6e..c44b6d170 100644 --- a/products/idn/docs/identity-now/saas-connectivity/commands/entitlement-list.md +++ b/products/idn/docs/identity-now/saas-connectivity/connector-commands/entitlement-list.md @@ -6,7 +6,7 @@ sidebar_label: Entitlement List keywords: ["connectivity", "connectors", "entitlement list"] description: Gather a list of all entitlements available on the source. slug: /docs/saas-connectivity/commands/entitlement-list -tags: ["Connectivity"] +tags: ["Connectivity", "Connector Command"] --- | Input/Output | Data Type | diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/entitlement-read.md b/products/idn/docs/identity-now/saas-connectivity/connector-commands/entitlement-read.md similarity index 97% rename from products/idn/docs/identity-now/saas-connectivity/commands/entitlement-read.md rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/entitlement-read.md index 1f01baa89..59232487e 100644 --- a/products/idn/docs/identity-now/saas-connectivity/commands/entitlement-read.md +++ b/products/idn/docs/identity-now/saas-connectivity/connector-commands/entitlement-read.md @@ -6,7 +6,7 @@ sidebar_label: Entitlement Read keywords: ["connectivity", "connectors", "entitlement read"] description: Fetch a single entitlement’s attributes from the source. slug: /docs/saas-connectivity/commands/entitlement-read -tags: ["Connectivity"] +tags: ["Connectivity", "Connector Command"] --- :::note diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/img/account_create_idn.png b/products/idn/docs/identity-now/saas-connectivity/connector-commands/img/account_create_idn.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/commands/img/account_create_idn.png rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/img/account_create_idn.png diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/img/account_list_idn.png b/products/idn/docs/identity-now/saas-connectivity/connector-commands/img/account_list_idn.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/commands/img/account_list_idn.png rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/img/account_list_idn.png diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/img/account_read_idn.png b/products/idn/docs/identity-now/saas-connectivity/connector-commands/img/account_read_idn.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/commands/img/account_read_idn.png rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/img/account_read_idn.png diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/img/create_password_idn.png b/products/idn/docs/identity-now/saas-connectivity/connector-commands/img/create_password_idn.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/commands/img/create_password_idn.png rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/img/create_password_idn.png diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/img/discover_schema_idn1.png b/products/idn/docs/identity-now/saas-connectivity/connector-commands/img/discover_schema_idn1.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/commands/img/discover_schema_idn1.png rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/img/discover_schema_idn1.png diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/img/discover_schema_idn2.png b/products/idn/docs/identity-now/saas-connectivity/connector-commands/img/discover_schema_idn2.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/commands/img/discover_schema_idn2.png rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/img/discover_schema_idn2.png diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/img/discover_schema_idn3.png b/products/idn/docs/identity-now/saas-connectivity/connector-commands/img/discover_schema_idn3.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/commands/img/discover_schema_idn3.png rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/img/discover_schema_idn3.png diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/img/discover_schema_idn4.png b/products/idn/docs/identity-now/saas-connectivity/connector-commands/img/discover_schema_idn4.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/commands/img/discover_schema_idn4.png rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/img/discover_schema_idn4.png diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/img/entitlement_list_idn.png b/products/idn/docs/identity-now/saas-connectivity/connector-commands/img/entitlement_list_idn.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/commands/img/entitlement_list_idn.png rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/img/entitlement_list_idn.png diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/img/test_command_idn.png b/products/idn/docs/identity-now/saas-connectivity/connector-commands/img/test_command_idn.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/commands/img/test_command_idn.png rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/img/test_command_idn.png diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/img/testing1.png b/products/idn/docs/identity-now/saas-connectivity/connector-commands/img/testing1.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/commands/img/testing1.png rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/img/testing1.png diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/img/testing2.png b/products/idn/docs/identity-now/saas-connectivity/connector-commands/img/testing2.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/commands/img/testing2.png rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/img/testing2.png diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/img/testing3.png b/products/idn/docs/identity-now/saas-connectivity/connector-commands/img/testing3.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/commands/img/testing3.png rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/img/testing3.png diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/index.md b/products/idn/docs/identity-now/saas-connectivity/connector-commands/index.md similarity index 68% rename from products/idn/docs/identity-now/saas-connectivity/commands/index.md rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/index.md index 7724ccd4d..e0f8f05dd 100644 --- a/products/idn/docs/identity-now/saas-connectivity/commands/index.md +++ b/products/idn/docs/identity-now/saas-connectivity/connector-commands/index.md @@ -1,17 +1,16 @@ --- -id: commands -title: Commands -pagination_label: Commands -sidebar_label: Commands +id: connector-commands +title: Connector Commands +pagination_label: Connector Commands +sidebar_label: Connector Commands sidebar_position: 7 -sidebar_class_name: commands +sidebar_class_name: connectorCommands keywords: ["connectivity", "connector", "commands"] description: All commands available to implement in a SaaS Connector. -slug: /docs/saas-connectivity/commands +slug: /docs/saas-connectivity/connector-commands tags: ["Connectivity"] --- -## Connector Commands Below you will find all of commands available to implement in a SaaS Connector. ```mdx-code-block diff --git a/products/idn/docs/identity-now/saas-connectivity/commands/test-connection.md b/products/idn/docs/identity-now/saas-connectivity/connector-commands/test-connection.md similarity index 98% rename from products/idn/docs/identity-now/saas-connectivity/commands/test-connection.md rename to products/idn/docs/identity-now/saas-connectivity/connector-commands/test-connection.md index 9e89b3fef..e732001a3 100644 --- a/products/idn/docs/identity-now/saas-connectivity/commands/test-connection.md +++ b/products/idn/docs/identity-now/saas-connectivity/connector-commands/test-connection.md @@ -6,7 +6,7 @@ sidebar_label: Test Connection keywords: ["connectivity", "connectors", "test connection"] description: Ensure the connector can communicate with the source. slug: /docs/saas-connectivity/commands/test-connection -tags: ["Connectivity"] +tags: ["Connectivity", "Connector Command"] --- | Input/Output | Data Type |