Okta
您可以使用 Okta 連接器建立、讀取、更新及刪除使用者、群組、角色和應用程式記錄,以及將使用者或群組指派或取消指派給角色和應用程式。
事前準備
在 Google Cloud 專案中執行下列工作:
- 確認已設定網路連線。如要瞭解網路模式,請參閱「網路連線」。
- 將 roles/connectors.admin IAM 角色授予設定連接器的使用者。
- 將
roles/secretmanager.viewer
和roles/secretmanager.secretAccessor
IAM 角色授予要用於連接器的服務帳戶。 - 啟用下列服務:
secretmanager.googleapis.com
(Secret Manager API)connectors.googleapis.com
(連接器 API)
如要瞭解如何啟用服務,請參閱「啟用服務」。如果先前未為專案啟用這些服務或權限,在設定連接器時,系統會提示您啟用這些服務或權限。
建立 Okta 連線
連線是特定資料來源的連線,也就是說,如果您有多個資料來源,則必須為每個資料來源建立個別的連線。如要建立連線,請按照下列步驟操作:
- 在 Cloud 控制台中,前往「Integration Connectors」>「Connections」頁面,然後選取或建立 Google Cloud 專案。
- 按一下「+ 建立新連線」,開啟「建立連線」頁面。
- 在「位置」部分,選擇連線的位置。
- 區域:從下拉式清單中選取位置。
如需所有支援地區的清單,請參閱「位置」一節。
- 點按「Next」。
- 區域:從下拉式清單中選取位置。
- 在「連線詳細資料」部分中,完成下列操作:
- 從「連接器」清單中選取「Okta」。
- 從「Connector version」清單中選取連接器版本。
- 在「連線名稱」欄位中,輸入連線執行個體的名稱。連線名稱可以包含小寫英文字母、數字或連字號。名稱開頭須為英文字母,結尾須為英文字母或數字,且名稱不得超過 49 個字元。
- 視需要輸入連線例項的「Description」(說明)。
- 您可以選擇啟用 Cloud Logging,然後選取記錄層級。根據預設,記錄層級會設為
Error
。 - 服務帳戶:選取具備必要角色的服務帳戶。
- (選用) 設定連線節點設定。
- 節點數量下限:輸入連線節點數量下限。
- 節點數量上限:輸入連線節點數量上限。
- 網域:輸入 Okta 網域,以便連線至 Okta 執行個體。
- 您可以按一下「+ 新增標籤」,以鍵/值組合的形式為連線新增標籤。
- 點按「Next」。
節點是用來處理交易的連線單位 (或備用資源)。處理的交易量越多,就需要越多節點;反之,處理的交易量越少,就需要越少節點。如要瞭解節點對連接器定價的影響,請參閱「 連線節點的定價」。如果您未輸入任何值,系統會預設將最小節點設為 2 (以提高可用性),並將最大節點設為 50。
-
在「Authentication」部分中,輸入驗證詳細資料。
- 選取「驗證類型」並輸入相關詳細資料。
Okta 連線支援下列驗證類型:
- OAuth 2.0 - 授權碼
- 使用 JWT 權杖的 OAuth 2.0 用戶端憑證
- 點按「Next」。
如要瞭解如何設定這些驗證類型,請參閱「設定驗證」。
- 選取「驗證類型」並輸入相關詳細資料。
- 查看:查看連線和驗證詳細資料。
- 按一下 [建立]。
設定驗證機制
根據要使用的驗證方法輸入詳細資料。
-
OAuth 2.0 - 授權碼
- 用戶端 ID:用於要求存取權憑證的用戶端 ID。
- 範圍:以半形逗號分隔的所需範圍清單。
- 用戶端密鑰:用於要求存取權存證的用戶端密鑰。
- 授權網址:建立用戶端時產生的授權網址。
對於 Authorization code
驗證類型,您必須在建立連線後,執行幾個額外的步驟來設定驗證。詳情請參閱「建立連線後的額外步驟」。
-
OAuth 2.0 - 使用 JWT 權杖的用戶端憑證
- 用戶端 ID:用於要求存取權憑證的用戶端 ID。
- 範圍:以半形逗號分隔的所需範圍清單。
- 私密金鑰:Secret Manager 密鑰,內含私密金鑰檔案的內容,格式為 PEM。私密金鑰必須與公開金鑰/憑證相符。
建立連線後的額外步驟
如果您選用 OAuth 2.0 - Authorization code
進行驗證,則必須在建立連線後執行下列額外步驟:
- 在「Connections」(連線) 頁面中,找出新建立的連線。
請注意,新連接器的狀態會是「需要授權」。
- 按一下「需要授權」。
這會顯示「Edit authorization」窗格。
- 將「Redirect URI」值複製到外部應用程式。
- 驗證授權詳細資料。
- 按一下「Authorize」。
如果授權成功,連線頁面中的連線狀態會設為「Active」。
重新授權授權碼
如果您使用 Authorization code
驗證類型,且已進行任何設定變更,則必須重新授權 Okta 連線。如要重新授權連線,請按照下列步驟操作:
- 在「Connections」(連線) 頁面中,按一下所需連線。
系統會開啟連線詳細資料頁面。
- 按一下「編輯」即可編輯連結詳細資料。
- 在「驗證」部分確認「OAuth 2.0 - 授權碼」詳細資料。
視需要進行必要的變更。
- 按一下 [儲存]。系統會將您導向連線詳細資料頁面。
- 在「驗證」部分中,按一下「編輯授權」。畫面上會顯示「Authorize」窗格。
- 按一下「Authorize」。
如果授權成功,「連線」頁面中的連線狀態就會設為「啟用」。
系統限制
Okta 連接器每個節點每秒最多可處理一筆交易,並會節流超出此限制的交易。根據預設,Integration Connectors 會為連線分配 2 個節點 (可提高可用性)。
如要瞭解 Integration Connectors 適用的限制,請參閱「限制」一節。
在整合中使用 Okta 連線
建立連線後,即可在 Apigee Integration 和 Application Integration 中使用。您可以透過「連接器」工作,在整合中使用連線。
- 如要瞭解如何在 Apigee Integration 中建立及使用連接器工作,請參閱「連接器工作」。
- 如要瞭解如何在 Application Integration 中建立及使用連接器工作,請參閱「連接器工作」。
動作
本節列出 Okta 連接器支援的動作。如要瞭解如何設定動作,請參閱「動作範例」。
ReactivateUser 動作
這項操作會重新啟用使用者。
ReactivateUser 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
UserID | 字串 | 是 | 使用者的 ID。 |
如需 ReactivateUser
動作的設定範例,請參閱「ActivateUser 範例」。
ActivateUser 動作
這項操作會啟用使用者。
ActivateUser 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
UserID | 字串 | 是 | 使用者的 ID。 |
如需 ActivateUser
動作的設定範例,請參閱「ActivateUser 範例」。
DeactivateUser 動作
這項操作會停用使用者。
DeactivateUser 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
UserID | 字串 | 是 | 使用者的 ID。 |
如需 DeactivateUser
動作的設定範例,請參閱「DeactivateUser 範例」。
Assignusertogroup 動作
這項操作會將使用者指派給群組。
Assignusertogroup 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
UserID | 字串 | 是 | 使用者的 ID。 |
GroupID | 字串 | 是 | 群組的 ID。 |
如需 Assignusertogroup
動作的設定範例,請參閱「將使用者指派給群組的範例」。
UnassignUsertoRole 動作
這項操作會取消使用者所屬角色。
UnassignUsertoRole 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
UserID | 字串 | 是 | 使用者的 ID。 |
RoleAssignmentId | 字串 | 是 | 角色的 ID。 |
如需設定 UnassignUsertoRole
動作的範例,請參閱「UnassignUsertoRole 範例」。
AssignUsertoRole 動作
這項操作會將使用者指派給角色。
AssignUsertoRole 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
UserID | 字串 | 是 | 使用者的 ID。 |
RoleId | 字串 | 是 | 角色的 ID。 |
如需 AssignUsertoRole
動作的設定範例,請參閱「AssignUsertoRole 範例」。
AssignUsertoApp 動作
這項操作會將使用者指派給應用程式。
AssignUsertoApp 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
UserID | 字串 | 是 | 使用者的 ID。 |
AppId | 字串 | 是 | 應用程式的 ID。 |
如需 AssignUsertoApp
動作的設定範例,請參閱「AssignUsertoApp 範例」。
UnassignUsertoGroup 動作
這項操作會將使用者從群組中解除指派。
UnassignUsertoGroup 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
UserID | 字串 | 是 | 使用者的 ID。 |
GroupID | 字串 | 是 | 群組的 ID。 |
如需設定 UnassignUsertoGroup
動作的範例,請參閱「UnassignUsertoGroup 範例」。
UnassignUsertoApp 動作
這項操作會將使用者從應用程式中取消指派。
UnassignUsertoApp 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
UserID | 字串 | 是 | 使用者的 ID。 |
AppID | 字串 | 是 | 應用程式的 ID。 |
如需設定 UnassignUsertoApp
動作的範例,請參閱「UnassignUsertoApp 範例」。
Assigngrouptoapp 動作
這項動作會將群組指派給應用程式。
Assigngrouptoapp 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
GroupId | 字串 | 是 | 群組的 ID。 |
AppID | 字串 | 是 | 應用程式的 ID。 |
如需 Assigngrouptoapp
動作的設定範例,請參閱「Assigngrouptoapp 範例」。
AssignGrouptoRole 動作
這項動作會將群組指派給角色。
AssignGrouptoRole 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
GroupId | 字串 | 是 | 群組 ID |
RoleId | 字串 | 是 | 角色 ID |
TypeId | 字串 | 是 | 類型的 ID |
如需 AssignGrouptoRole
動作的設定範例,請參閱「AssignGrouptoRole 範例」。
UnassignGrouptoApp 動作
這項動作會取消指派應用程式群組。
UnassignGrouptoApp 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
群組 | 字串 | 是 | 群組 ID 的 ID |
AppID | 字串 | 是 | 應用程式 ID |
如需設定 UnassignGrouptoApp
動作的範例,請參閱「UnassignGrouptoApp 範例」。
UnassignGrouptoRole 動作
這項操作會將群組從角色中取消指派。
UnassignGrouptoRole 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
群組 | 字串 | 是 | 群組 ID 的 ID |
AppID | 字串 | 是 | AppId 的 ID |
如需設定 UnassignGrouptoRole
動作的範例,請參閱「UnassignGrouptoRole 範例」。
SuspendUser 動作
這項操作會將使用者停權。
SuspendUser 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
群組 | 字串 | 是 | GroupId 的 ID。 |
AppID | 字串 | 是 | AppId 的 ID。 |
如需 SuspendUser
動作的設定方法範例,請參閱「SuspendUser 範例」。
UnsuspendUser 動作
這項操作會解除使用者的停權狀態。
UnsuspendUser 動作的輸入參數
參數名稱 | 資料類型 | 必填 | 說明 |
---|---|---|---|
群組 | 字串 | 是 | GroupId 的 ID。 |
AppID | 字串 | 是 | AppId 的 ID。 |
如需 UnsuspendUser
動作的設定範例,請參閱「UnsuspendUser 範例」。
行動號召範例
範例:重新啟用使用者
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
ReactivateUser
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "00ulgqf2s4Zs5Ohge5d7" }
如果動作成功,ReactivateUser
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
{ "Status": "Success", "ActivationToken": "PKeQTJMUW9vg0wyh8czA", "ActivationUrl": "https://dev-99779501.okta.com/tokens/PKeQTJMUW9vg0wyh8czA/verify" }
範例:啟用使用者
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
ActivateUser
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "00ulgqf2s4Zs5Ohge5d7" }
如果動作成功,ActivateUser
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
{ "Status": "Success", "activationurl": null, "activationtoken": null }
範例:停用使用者
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
DeactivateUser
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "00ulgqf2s4Zs5Ohge5d7" }
如果動作成功,DeactivateUser
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
{ "Status": "Success", "activationurl": null, "activationtoken": null }
範例:將使用者指派給群組
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
Assignusertogroup
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "00ulgqf2s4Zs5Ohge5d7", "GroupId": "7463874b834938475d" }
如果動作成功,Assignusertogroup
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
{ "Status": "Success", }
範例:取消指派使用者角色
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
UnassignUsertoRole
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "00ukxucmpl25SNLP65d7", "RoleAssignmentId": "irblawnjpom1bLBcJ5d7" }
如果動作成功,UnassignUsertoRole
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
{ "Status": "Success", }
範例:將使用者指派給角色
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
AssignUsertoRole
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "00ukxucmpl25SNLP65d7", "RoleId": "cr0l2n9ay0pCCxLgG5d7", "ResourceSet": "iaml81kep6zefR4Oq5d7", "Type": "CUSTOM" }
如果動作成功,AssignUsertoRole
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
{ "Status": "Success", "Id": "irblawfe99RsUfILD5d7", "Label": "UserCreatorByabhishkePostman", "Type": "CUSTOM", "Created": "2024-11-21 07:33:05.0", "LastUpdated": "2024-11-21 07:33:05.0", "AssignmentStatus": "ACTIVE", "AssignmentType": "USER", "resource-set": "iaml81kep6zefR4Oq5d7", "role": "cr0l2n9ay0pCCxLgG5d7", "_links_role_href": "https://dev-99779501-admin.okta.com/api/v1/iam/roles/cr0l2n9ay0pCCxLgG5d7", "_links_resource-set_href": "https://dev-99779501.okta.com/api/v1/iam/resource-sets/iaml81kep6zefR4Oq5d7", "_links_permissions_href": "https://dev-99779501-admin.okta.com/api/v1/iam/roles/cr0l2n9ay0pCCxLgG5d7/permissions", "_links_member_href": "https://dev-99779501.okta.com/api/v1/iam/resource-sets/iaml81kep6zefR4Oq5d7/bindings/cr0l2n9ay0pCCxLgG5d7/members/irblawfe99RsUfILD5d7", "_links_assignee_href": "https://dev-99779501.okta.com/api/v1/users/00ukxucmpl25SNLP65d7" }
範例:將使用者指派給應用程式
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
AssignUsertoApp
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "00ukxucmpl25SNLP65d7", "AppId": "0oakn3j0bfGPR1Esk5d7" }
如果動作成功,AssignUsertoApp
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
{ "Status": "Success", "Id": "00ukxucmpl25SNLP65d7", "Created": "2024-11-21 07:08:40.0", "LastUpdated": "2024-11-21 07:08:45.0", "Scope": "USER", "AssignmentStatus": "ACTIVE", "externalid": null, "statuschanged": "2024-11-21T07:08:40.000Z", "passwordchanged": null, "syncstate": "DISABLED", "credentials_username": "baklavainthebalkans@gmail.com", "profile_street_address": null, "profile_country": null, "profile_website": null, "profile_zoneinfo": "America/Los_Angeles", "profile_birthdate": null, "profile_gender": null, "profile_formatted": null, "profile_profile": null, "profile_locality": null, "profile_given_name": "Baklavainthe", "profile_middle_name": null, le_phone_number": null, "profile_region": null, "profile_postal_code": null, "profile_family_name": "Balkans", "profile_email": "baklavainthebalkans@gmail.com", "_links_app_href": "https://dev-99779501.okta.com/api/v1/apps/0oakn3j0bfGPR1Esk5d7", "_links_user_href": "https://dev-99779501.okta.com/api/v1/users/00ukxucmpl25SNLP65d7" }
範例:從群組中取消指派使用者
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
UnassignUsertoGroup
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "00ukxucmpl25SNLP65d7", "GroupId": "0oakn3j0bfGPR1Esk5d7" }
如果動作成功,UnassignUsertoGroup
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
{ "Status": "Success" }
範例:為應用程式取消指派使用者
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
UnassignUsertoApp
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "00ukxucmpl25SNLP65d7", "AppId": "0oakn3j0bfGPR1Esk5d7" }
如果動作成功,UnassignUsertoApp
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
{ "Status": "Success" }
範例:將群組指派給應用程式
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
Assigngrouptoapp
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "GroupId": "00gl5wovm8GuLr8vg5d7", "AppId": "0oakn3j0bfGPR1Esk5d7" }
如果動作成功,Assigngrouptoapp
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
{ "Status": "Success", "Id": "00gl5wovm8GuLr8vg5d7", "LastUpdated": "2024-11-21 08:42:53.0", "Priority": 0, "_links_app_href": "https://dev-99779501.okta.com/api/v1/apps/0oakn3j0bfGPR1Esk5d7", "_links_self_href": "https://dev-99779501.okta.com/api/v1/apps/0oakn3j0bfGPR1Esk5d7/groups/00gl5wovm8GuLr8vg5d7", "_links_group_href": "https://dev-99779501.okta.com/api/v1/groups/00gl5wovm8GuLr8vg5d7" }
範例:將群組指派給角色
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
AssignGrouptoRole
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "GroupId": "00gl9xqojqXq0TJgS5d7", "RoleId": "cr0l5tqddvkDtcfPl5d7", "Type": "CUSTOM", "ResourceSet": "iaml81kep6zefR4Oq5d7" }
如果動作成功,AssignGrouptoRole
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
{ "Status": "Success", "Id": "irbla1k8uy8XxDDFF5d7", "Label": "ReadAdmin_Altostrat", "Type": "CUSTOM", "Created": "2024-11-20 12:28:33.0", "LastUpdated": "2024-11-20 12:28:33.0", "AssignmentStatus": "ACTIVE", "AssignmentType": "GROUP", "resource-set": "iaml81kep6zefR4Oq5d7", "role": "cr0l5tqddvkDtcfPl5d7", "_links_role_href": "https://dev-99779501-admin.okta.com/api/v1/iam/roles/cr0l5tqddvkDtcfPl5d7", "_links_resource-set_href": "https://dev-99779501.okta.com/api/v1/iam/resource-sets/iaml81kep6zefR4Oq5d7", "_links_permissions_href": "https://dev-99779501-admin.okta.com/api/v1/iam/roles/cr0l5tqddvkDtcfPl5d7/permissions", "_links_member_href": "https://dev-99779501.okta.com/api/v1/iam/resource-sets/iaml81kep6zefR4Oq5d7/bindings/cr0l5tqddvkDtcfPl5d7/members/irbla1k8uy8XxDDFF5d7", "_links_assignee_href": "https://dev-99779501.okta.com/api/v1/groups/00gl9xqojqXq0TJgS5d7" }
範例:從應用程式中取消指派群組
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
UnassignGrouptoApp
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "GroupId": "00gl5wovm8GuLr8vg5d7", "AppId": "0oakn3j0bfGPR1Esk5d7" }
如果動作成功,UnassignGrouptoApp
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
{ "Status": "Success" }
範例:取消指派角色的群組
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
UnassignGrouptoRole
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "GroupId": "00gl5wovm8GuLr8vg5d7", "RoleAssignmentId": "irbl94sbyit77SGpg5d7" }
如果動作成功,UnassignGrouptoRole
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
{ "Status": "Success" }
範例:將使用者停權
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
SuspendUser
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "00ulkdsubxO6W6LgJ5d7" }
如果動作成功,SuspendUser
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
{ "Status": "Success" }
範例:取消使用者停權
- 在
Configure connector task
對話方塊中,按一下Actions
。 - 選取
UnsuspendUser
動作,然後按一下「Done」。 - 在「Connectors」任務的「Task Input」部分,按一下
connectorInputPayload
,然後在Default Value
欄位中輸入類似以下的值:{ "UserId": "00ulkdsubxO6W6LgJ5d7" }
如果動作成功,UnsuspendUser
工作項的 connectorOutputPayload
回應參數會包含類似以下的值:
{ "Status": "Success" }
實體操作範例
本節說明如何在這個連接器中執行部分實體作業。
範例:列出所有使用者
- 在
Configure connector task
對話方塊中,按一下Entities
。 - 從
Entity
清單中選取「使用者」。 - 選取
List
作業,然後按一下「Done」。 - 在「Connector」工作中的「Task Input」部分,您可以根據需求設定「filterClause」。
您必須使用單引號 (') 括住篩選器子句的值。您可以使用篩選子句,根據資料欄篩選記錄。
範例 - 取得使用者
- 在
Configure connector task
對話方塊中,按一下Entities
。 - 從
Entity
清單中選取Users
。 - 選取
Get
作業,然後按一下「Done」。 - 將實體 ID 設為「20001」,這是要傳遞的鍵。如要設定實體 ID,請在「資料對應」的「資料對應」專區中,按一下「開啟資料對應編輯器」,然後在「輸入值」欄位中輸入
"20001"
,並選擇「EntityId」做為「Local」變數。
您必須直接傳遞實體 ID,例如「20001」。此處的「20001」是傳遞的唯一主鍵值
在傳遞實體 ID 會擲回錯誤的查詢中,您必須使用篩選器子句,因為會出現兩個複合鍵,例如 id='20001'
範例:刪除使用者
- 在
Configure connector task
對話方塊中,按一下Entities
。 - 從
Entity
清單中選取Users
。 - 選取
Delete
作業,然後按一下「Done」。 - 將實體 ID 設為「00ul7l5fdyTdHDfSj5d7」,這是要傳遞的鍵。如要設定實體 ID,請在「資料對應」的「資料對應」部分,按一下「開啟資料對應編輯器」,然後在「輸入值」欄位中輸入
"20001"
,並選擇「EntityId」做為「Local」變數。如果實體有兩個複合式商家或主鍵,而非指定 entityId,您也可以將 filterClause 設為
id='00ul7l5fdyTdHDfSj5d7'
。
範例:建立使用者
- 在
Configure connector task
對話方塊中,按一下Entities
。 - 從
Entity
清單中選取Users
。 - 選取
Create
運算,然後按一下「Done」。 - 在「資料對應」任務的「資料對應器」部分,按一下
Open Data Mapping Editor
,然後在Input Value
欄位中輸入類似下列的值,並選擇 EntityId/ConnectorInputPayload 做為本機變數。{ "ProfileFirstName": "Test", "ProfileLastName": "Test User", "ProfileEmail": "Test@gmail.com", "ProfileLogin": "Test11@example.com" }
如果整合成功,
Vendor
工作項的connectorOutputPayload
回應參數會包含類似以下的值:{ "Id": "00ula502hjbwWYsO25d7" }
範例:建立群組
- 在
Configure connector task
對話方塊中,按一下Entities
。 - 從
Entity
清單中選取Groups
。 - 選取
Create
運算,然後按一下「Done」。 - 在「資料對應」任務的「資料對應器」部分,按一下
Open Data Mapping Editor
,然後在Input Value
欄位中輸入類似下列的值,並選擇 EntityId/ConnectorInputPayload 做為本機變數。{ "ProfileDescription": "Googlecloud group", "ProfileName": "Goolecloud created grp\n" }
如果整合成功,
APBill
工作項的connectorOutputPayload
回應參數會包含類似以下的值:{ "Id": "00gl7lb5gniIAOMwA5d7" }
範例:建立應用程式
- 在
Configure connector task
對話方塊中,按一下Entities
。 - 從
Entity
清單中選取Apps
。 - 選取
Create
運算,然後按一下「Done」。 - 在「資料對應」任務的「資料對應器」部分,按一下
Open Data Mapping Editor
,然後在Input Value
欄位中輸入類似下列的值,並選擇 EntityId/ConnectorInputPayload 做為本機變數。{ "Label": "Googlecloud generated app", "SignOnMode": "AUTO_LOGIN", "AutoSubmitToolbar": false, "Settings": "{\"signOn\":{\"redirectUrl\":\"https://www.example.com\",\"loginUrl\":\"https://www.example.com\"}}" }
這個範例會建立 Vendtype。如果整合成功,
Vendtype
工作項的connectorOutputPayload
回應參數會包含類似以下的值:{ "Id": "0oal9vwooxEXXpdjS5d7" }
範例:建立角色
- 在
Configure connector task
對話方塊中,按一下Entities
。 - 從
Entity
清單中選取Roles
。 - 選取
Create
運算,然後按一下「Done」。 - 在「資料對應」任務的「資料對應器」部分,按一下
Open Data Mapping Editor
,然後在Input Value
欄位中輸入類似下列的值,並選擇 EntityId/ConnectorInputPayload 做為本機變數。{ "Label": "new role2", "Description": "GABA Role1", "Permissions": "\"okta.users.read\", \"okta.groups.read\"" }
如果整合成功,
Customer
工作項的connectorOutputPayload
回應參數會包含類似以下的值:{ "Id": "cr0l824rbiTvtJDoi5d7" }
範例:更新使用者
- 在
Configure connector task
對話方塊中,按一下Entities
。 - 從
Entity
清單中選取Users
。 - 選取
Update
運算,然後按一下「Done」。 - 在「資料對應」任務的「資料對應器」部分,按一下
Open Data Mapping Editor
,然後在Input Value
欄位中輸入類似下列的值,並選擇 EntityId/ConnectorInputPayload/FilterClause 做為「Local」變數。{ "ProfileFirstName": "ShubhGillL" }
- 將資料對應工具中的實體 ID 設為 Users 實體。如要設定實體 ID,請按一下
Open Data Mapping Editor
,然後在Input Value
欄位中輸入類似下列的值,並選擇 EntityId/ConnectorInputPayload/FilterClause 做為本機變數。您可以將 filterClause 設為
20044
,而非指定 entityId。執行這個範例時,會傳回類似以下的回應,並顯示在連接器工作項的
connectorOutputPayload
輸出變數中:{ "Id": "00ul7u8cyobt8SGRK5d7" }
範例:更新群組
- 在
Configure connector task
對話方塊中,按一下Entities
。 - 從
Entity
清單中選取Groups
。 - 選取
Update
運算,然後按一下「Done」。 - 在「資料對應」任務的「資料對應器」部分,按一下
Open Data Mapping Editor
,然後在Input Value
欄位中輸入類似下列的值,並選擇 EntityId/ConnectorInputPayload/FilterClause 做為「Local」變數。{ "ProfileName": "Updated Googlecloud group" }
- 將 Data Mapper 中的實體 ID 設為群組實體。如要設定實體 ID,請按一下
Open Data Mapping Editor
,然後在Input Value
欄位中輸入類似下列的值,並選擇 EntityId/ConnectorInputPayload/FilterClause 做為本機變數。您可以將 filterClause 設為
1371
,而非指定 entityId。執行這個範例時,會傳回類似以下的回應,並顯示在連接器工作項的
connectorOutputPayload
輸出變數中:{ "Id": "00gl92veg4VSQQb5A5d7" }
範例:更新應用程式
- 在
Configure connector task
對話方塊中,按一下Entities
。 - 從
Entity
清單中選取Apps
。 - 選取
Update
運算,然後按一下「Done」。 - 在「資料對應」任務的「資料對應器」部分,按一下
Open Data Mapping Editor
,然後在Input Value
欄位中輸入類似下列的值,並選擇 EntityId/ConnectorInputPayload/FilterClause 做為「Local」變數。{ "Label": "Googlecloud updated label" }
- 將 Data Mapper 中的實體 ID 設為應用程式的實體。如要設定實體 ID,請按一下
Open Data Mapping Editor
,然後在Input Value
欄位中輸入類似下列的值,並選擇 EntityId/ConnectorInputPayload/FilterClause 做為本機變數。您可以將 filterClause 設為
Customerid='10100'\n
,而非指定 entityId。執行這個範例時,會傳回類似以下的回應,並顯示在連接器工作項的
connectorOutputPayload
輸出變數中:{ "Id": "0oal9vwooxEXXpdjS5d7" }
範例:更新角色
- 在
Configure connector task
對話方塊中,按一下Entities
。 - 從
Entity
清單中選取Roles
。 - 選取
Update
運算,然後按一下「Done」。 - 在「資料對應」任務的「資料對應器」部分,按一下
Open Data Mapping Editor
,然後在Input Value
欄位中輸入類似下列的值,並選擇 EntityId/ConnectorInputPayload/FilterClause 做為「Local」變數。{ "Label": "Googlecloud updated label" }
- 將 Data Mapper 中的實體 ID 設為角色實體。如要設定實體 ID,請按一下
Open Data Mapping Editor
,然後在Input Value
欄位中輸入類似下列的值,並選擇 EntityId/ConnectorInputPayload/FilterClause 做為本機變數。您可以將 filterClause 設為
1
,而非指定 entityId。執行這個範例時,會傳回類似以下的回應,並顯示在連接器工作項的
connectorOutputPayload
輸出變數中:{ "Id": "cr0l7dqeatRuIrn5x5d7" }