uip 管理者 external-apps

「uip admin external-apps」の構文とオプション - 外部アプリケーション連携のための OAuth2 クライアントの登録とそのフェデレーション資格情報を管理します。

uip admin external-apps は、OAuth2 クライアントの登録を管理します。OAuth2 クライアントの登録は、ユーザー自身のログインではなく、自身のクライアント ID/シークレット (またはワークロード ID フェデレーション) を使用して UiPath に対して認証する外部アプリケーションとサービスです。各アプリは、 機密 (サーバー側、シークレットあり) または 非機密 (パブリック (SPA またはモバイル アプリなど、シークレットなし) のいずれかです。入れ子になった federated-credentials グループは、ワークロードと ID とフェデレーションのバインドを管理します (例:GitHub Actions OIDC) を使用すると、外部アプリは静的シークレットを一切使用せずに認証できます。

概要

uip admin external-apps list
uip admin external-apps get <client-id>
uip admin external-apps create <name> [--redirect-uri <uri>] [--user-scope <scopes>] [--app-scope <scopes>] [--non-confidential] [--no-secret]
uip admin external-apps update <client-id> [--name <name>] [--redirect-uri <uri>] [--user-scope <scopes>] [--app-scope <scopes>]
uip admin external-apps delete <client-id>
uip admin external-apps generate-secret <client-id> [--description <text>] [--expiration <date>]
uip admin external-apps delete-secret <secret-id>

uip admin external-apps federated-credentials list <client-id>
uip admin external-apps federated-credentials get <client-id> <credential-id>
uip admin external-apps federated-credentials create <client-id> --name <name> --issuer <url> --audience <audience> --subject <subject>
uip admin external-apps federated-credentials update <client-id> <credential-id> --name <name> --issuer <url> --audience <audience> --subject <subject>
uip admin external-apps federated-credentials delete <client-id> <credential-id>

動詞

グループ	動詞	目的
external-apps	list	パーティション内の外部アプリのリストを取得します。
external-apps	get	クライアント ID でアプリの詳細を取得します。
external-apps	create	新しい OAuth2 クライアントを登録します。
external-apps	update	アプリの名前、リダイレクト URI、スコープを更新します。
external-apps	delete	クライアント ID でアプリを削除します。
external-apps	generate-secret	新しいクライアント シークレットを生成する。
external-apps	delete-secret	特定のクライアント シークレットを削除します。
federated-credentials	list	アプリのフェデレーション資格情報を一覧表示します。
federated-credentials	get	フェデレーション資格情報を ID で取得します。
federated-credentials	create	外部 ID プロバイダーをバインドします (例:GitHub Actions OIDC) をアプリに追加します。
federated-credentials	update	フェデレーション資格情報を更新します。
federated-credentials	delete	フェデレーション資格情報を削除します。

概念

• 機密と非機密既定値は [機密] です (サーバー側で、クライアント シークレットを取得します)。--non-confidential は、シークレットなしでパブリック クライアントを作成します。 --user-scope (委任された) スコープのみをサポートし、 --app-scopeはサポートしません。非機密アプリに --app-scope を渡すと、クライアント側では失敗します。
• 範囲は助成金の種類別に分割されます。--user-scope (委任され、サインインしているユーザーが必要) と --app-scope (アプリ専用、クライアント資格情報の付与) は独立したリストであり、一方または両方を渡します。createには少なくとも 1 つが必要です。利用可能なスコープ名の完全なカタログについては、 uip admin scopes list をご覧ください。
• --scope は、 --app-scopeの非推奨のエイリアスです。両方が与えられた場合、 --app-scope が勝ちます。いずれかの空白値 (空の文字列または空白のみの文字列) は、「スコープなし」としてサイレントに扱われるのではなく、拒否されます。
• リダイレクト URI は、アプリが非機密であるか、--user-scope渡されたため、ユーザー スコープが関係するときは常に OAuth2 認証コード フローを必要とするためです。機密であり、アプリ スコープのみのアプリには、必要ありません。
• update は、リソースを渡さない場合にリソースからスコープを再派生します。--user-scope と --app-scopeの両方を省略すると、アプリの既存のスコープがクリアされるのではなく、変更されずに再送信されます。createと同じ非機密/リダイレクト URI の検証は、最終的なスコープ セットとリダイレクト URI が何であれ、引き続き適用されます。
• シークレットは一度だけ表示されます。generate-secretの戻り値は再度取得できません。すぐに保存してください。

uip 管理者 external-apps のリスト

パーティション内の外部アプリのリストを取得します。フィルター処理/ページネーションのオプションはありません。

例

uip admin external-apps list

データシェイプ(--output json)

{ "Code": "ExternalClientList", "Data": [{ "id": "my-app", "name": "My Application", "isConfidential": true }] }

uip admin external-apps get

外部アプリの詳細をクライアント ID で取得します。

引数

名前	Required	目的
<client-id>	○	外部アプリ ID。external-apps listで検索する

例

uip admin external-apps get my-app

データシェイプ(--output json)

{ "Code": "ExternalClientDetails", "Data": { "id": "my-app", "name": "My Application", "isConfidential": true, "redirectUri": "https://example.com/callback" } }

uip admin external-apps create

外部アプリを作成します (既定では機密)。

引数

名前	Required	目的
<name>	○	アプリの表示名。

オプション

長押し	値 (Value)	説明
--redirect-uri <uri>	コンマ区切り	OAuth2 フローのリダイレクト URI。非機密の場合、または --user-scope が設定されている場合に必須です。
--user-scope <scopes>	コンマ区切りまたはスペース区切り	委任された (ユーザー) スコープ。
--app-scope <scopes>	コンマ区切りまたはスペース区切り	アプリケーション (アプリ専用) スコープ非機密アプリでは許可されません。
--scope <scopes>	コンマ区切りまたはスペース区切り	--app-scopeのエイリアスは非推奨です。
--non-confidential	フラグ	パブリック クライアントを作成します (シークレットなし)。
--no-secret	フラグ	作成時にクライアント シークレットを生成することをスキップします (機密アプリのみ)。

少なくとも --user-scope/--app-scope の 1 つが必要です。

例

# Confidential app with application scopes only
uip admin external-apps create "My App" --app-scope "OR.Folders,OR.Assets"

# Confidential app with both user and app scopes
uip admin external-apps create "My App" --user-scope "OR.Folders" --app-scope "OR.Jobs" --redirect-uri "https://example.com/callback"

# Public client (SPA) with user scopes
uip admin external-apps create "My SPA" --non-confidential --user-scope "OR.Folders" --redirect-uri "http://localhost:3000/callback"

データシェイプ(--output json)

{ "Code": "ExternalClientCreated", "Data": { "id": "my-app", "name": "My App", "isConfidential": true, "secret": "generated-secret-value" } }

secret は、 を --no-secretせずに作成された機密アプリにのみ存在します。

uip 管理者 external-apps の更新

アプリの名前、リダイレクト URI、スコープを更新します。--name/--redirect-uri/--user-scope/--app-scope のいずれか 1 つ以上が必要です。

引数

名前	Required	目的
<client-id>	○	外部アプリ ID。

オプション

長押し	Short	値 (Value)	説明
--name <name>	-n	string	新しい表示名。
--redirect-uri <uri>		コンマ区切り	新しいリダイレクト URI。
--user-scope <scopes>		コンマ区切りまたはスペース区切り	新しい委任されたスコープ
--app-scope <scopes>		コンマ区切りまたはスペース区切り	新しいアプリケーション スコープ
--scope <scopes>		コンマ区切りまたはスペース区切り	--app-scopeのエイリアスは非推奨です。

例

uip admin external-apps update my-app-id --name "Updated App" --app-scope "OR.Folders"

データシェイプ(--output json)

{ "Code": "ExternalClientUpdated" }

uip admin external-apps delete

外部アプリをクライアント ID で削除する。

引数

名前	Required	目的
<client-id>	○	外部アプリ ID。

例

uip admin external-apps delete my-app-id

データシェイプ(--output json)

{ "Code": "ExternalClientDeleted", "Data": { "Id": "my-app-id", "Status": "Deleted successfully" } }

uip 管理者 external-apps generate-secret

外部アプリの新しいシークレットを生成する。シークレット値は一度だけ表示されます。

引数

名前	Required	目的
<client-id>	○	外部アプリ ID。

オプション

長押し	値 (Value)	説明
--description <text>	string	シークレットの説明。
--expiration <date>	ISO8601認証取得	有効期限。

例

uip admin external-apps generate-secret my-app

データシェイプ(--output json)

{ "Code": "ExternalClientSecretGenerated", "Data": { "id": 1, "secret": "generated-secret-value" } }

uip admin external-apps delete-secret

外部アプリから特定のシークレットを削除する — 1 つのアプリに複数のアクティブなシークレットを含めることができます。これにより、削除されるのは 1 つだけです。

引数

名前	Required	目的
<secret-id>	○	シークレット ID (数値)。external-apps getで検索できます。

例

uip admin external-apps delete-secret 12345

データシェイプ(--output json)

{ "Code": "ExternalClientSecretDeleted", "Data": { "Id": "12345", "Status": "Deleted successfully" } }

uip admin external-apps federated-credentials list

外部アプリのフェデレーション資格情報を一覧表示します。

引数

名前	Required	目的
<client-id>	○	外部アプリ ID。

例

uip admin external-apps federated-credentials list my-app-id

データシェイプ(--output json)

{ "Code": "FederatedCredentialList", "Data": [{ "id": "fc000000-0000-0000-0000-000000000001", "name": "GitHub Actions", "issuer": "https://token.actions.githubusercontent.com" }] }

uip admin external-apps federated-credentials get

フェデレーション資格情報を ID で取得します。

引数

名前	Required	目的
<client-id>	○	外部アプリ ID。
<credential-id>	○	フェデレーション資格情報 (UUID)。

例

uip admin external-apps federated-credentials get my-app-id fc000000-0000-0000-0000-000000000001

データシェイプ(--output json)

{
  "Code": "FederatedCredentialDetails",
  "Data": {
    "id": "fc000000-0000-0000-0000-000000000001",
    "name": "GitHub Actions",
    "issuer": "https://token.actions.githubusercontent.com",
    "audience": "api://AzureADTokenExchange",
    "subject": "repo:org/repo:ref:refs/heads/main"
  }
}

uip admin external-apps federated-credentials 作成

外部 ID プロバイダーをアプリにバインドする — ワークロード ID フェデレーション (例: GitHub Actions ワークフローによる、シークレットを保存せずに認証) を有効化します。

引数

名前	Required	目的
<client-id>	○	外部アプリ ID。

オプション

長押し	Short	値 (Value)	Required	説明
--name <name>	-n	string	○	資格情報名。
--issuer <url>		url	○	トークン発行者の URL (例:https://token.actions.githubusercontent.comです。
--audience <audience>		string	○	期待されるオーディエンスの主張 (例:api://AzureADTokenExchangeです。
--subject <subject>		string	○	期待されるサブジェクトのクレーム。例:repo:org/repo:ref:refs/heads/mainです。
--description <text>		string	×	説明

例

uip admin external-apps federated-credentials create my-app-id \
  --name "GitHub Actions" \
  --issuer "https://token.actions.githubusercontent.com" \
  --audience "api://AzureADTokenExchange" \
  --subject "repo:org/repo:ref:refs/heads/main"

データシェイプ(--output json)

{ "Code": "FederatedCredentialCreated" }

uip admin external-apps federated-credentials の更新

フェデレーション資格情報を更新する — 4 つの ID フィールドはすべて呼び出しで必須です (部分的な更新はなし)。

引数

名前	Required	目的
<client-id>	○	外部アプリ ID。
<credential-id>	○	フェデレーション資格情報 (UUID)。

オプション

長押し	Short	値 (Value)	Required	説明
--name <name>	-n	string	○	資格情報名。
--issuer <url>		url	○	トークン発行者の URL。
--audience <audience>		string	○	期待されるオーディエンスのクレーム。
--subject <subject>		string	○	期待されるサブジェクトのクレーム。
--description <text>		string	×	説明

例

uip admin external-apps federated-credentials update my-app-id fc000000-0000-0000-0000-000000000001 \
  --name "GitHub Actions (prod)" \
  --issuer "https://token.actions.githubusercontent.com" \
  --audience "api://AzureADTokenExchange" \
  --subject "repo:org/repo:environment:production"

データシェイプ(--output json)

{ "Code": "FederatedCredentialUpdated" }

uip admin external-apps federated-credentials 削除

外部アプリからフェデレーション資格情報を削除します。

引数

名前	Required	目的
<client-id>	○	外部アプリ ID。
<credential-id>	○	フェデレーション資格情報 (UUID)。

例

uip admin external-apps federated-credentials delete my-app-id fc000000-0000-0000-0000-000000000001

データシェイプ(--output json)

{ "Code": "FederatedCredentialDeleted", "Data": { "Id": "fc000000-0000-0000-0000-000000000001", "Status": "Deleted successfully" } }

関連

• uip admin robot-accounts/pat/scopes — これらのアプリが取得する共有の OAuth2 スコープ カタログ。
• uip admin users — ディレクトリ ユーザーとディレクトリ グループ
• uip admin smtp — 組織のメールの設定です。

参照

• グローバル オプション
• 終了コード