cloudforet-apis
  • README
  • content
    • en
      • Cloudforet API Documentation
      • board
        • _index
        • v1
          • Board
          • Post
          • v1
      • config
        • _index
        • v1
          • DomainConfig
          • PublicConfig
          • UserConfig
          • WorkspaceConfig
          • v1
      • core
        • _index
        • v1
          • Handler
          • Query
          • ServerInfo
          • v1
        • v2
          • Handler
          • Plugin
          • Query
          • v2
      • cost_analysis
        • _index
        • plugin
          • Cost
          • DataSource
          • Job
          • plugin
        • v1
          • Budget
          • BudgetUsage
          • Cost
          • CostQuerySet
          • CostReport
          • CostReportConfig
          • CostReportData
          • CustomWidget
          • DataSource
          • DataSourceAccount
          • DataSourceRule
          • ExchangeRate
          • Job
          • JobTask
          • PublicDashboard
          • Schedule
          • UnifiedCost
          • UserDashboard
          • v1
      • dashboard
        • _index
        • v1
          • CustomWidget
          • Dashboard
          • DomainDashboard
          • PrivateDashboard
          • PrivateDataTable
          • PrivateFolder
          • PrivateWidget
          • ProjectDashboard
          • PublicDashboard
          • PublicDataTable
          • PublicFolder
          • PublicWidget
          • v1
      • file_manager
        • _index
        • v1
          • File
          • PublicFile
          • v1
      • identity
        • _index
        • plugin
          • AccountCollector
          • Auth
          • ExternalAuth
          • plugin
        • v1
          • ApiKey
          • Authorization
          • Domain
          • DomainOwner
          • Endpoint
          • Policy
          • Project
          • ProjectGroup
          • Provider
          • Role
          • RoleBinding
          • ServiceAccount
          • Token
          • User
          • v1
        • v2
          • Agent
          • ApiKey
          • App
          • Authorization
          • Domain
          • Endpoint
          • ExternalAuth
          • Job
          • Package
          • Policy
          • Project
          • ProjectGroup
          • Provider
          • Role
          • RoleBinding
          • Schema
          • ServiceAccount
          • System
          • Token
          • TrustedAccount
          • TrustedServiceAccount
          • User
          • UserGroup
          • UserProfile
          • Workspace
          • WorkspaceGroup
          • WorkspaceGroupDetails
          • WorkspaceGroupUser
          • WorkspaceUser
          • v2
      • inventory
        • _index
        • plugin
          • Collector
          • Job
          • plugin
        • v1
          • ChangeHistory
          • CloudService
          • CloudServiceQuerySet
          • CloudServiceReport
          • CloudServiceStats
          • CloudServiceType
          • Collector
          • CollectorRule
          • Job
          • JobTask
          • Metric
          • MetricData
          • MetricExample
          • Namespace
          • Note
          • Region
          • ResourceGroup
          • v1
        • v2
          • Region
          • v2
      • monitoring
        • _index
        • plugin
          • DataSource
          • Event
          • Log
          • Metric
          • Webhook
          • plugin
        • v1
          • Alert
          • DataSource
          • EscalationPolicy
          • Event
          • EventRule
          • Log
          • MaintenanceWindow
          • Metric
          • Note
          • ProjectAlertConfig
          • Webhook
          • v1
      • mzc_service_api
        • _index
        • v1
          • Contract
          • Offering
          • Organization
          • v1
      • notification
        • _index
        • plugin
          • Notification
          • Protocol
          • plugin
        • v1
          • Notification
          • NotificationUsage
          • ProjectChannel
          • Protocol
          • Quota
          • UserChannel
          • v1
      • opsflow
        • _index
        • v1
          • Comment
          • Event
          • Task
          • TaskCategory
          • TaskType
          • v1
      • plugin
        • _index
        • v1
          • Plugin
          • Supervisor
          • v1
      • repository
        • _index
        • v1
          • DashboardTemplate
          • Plugin
          • Policy
          • Repository
          • Schema
          • v1
        • v2
          • Common
          • Provider
          • RemoteRepository
          • Schema
          • v2
      • sample
        • _index
        • v1
          • Helloworld
          • v1
      • search
        • _index
        • v1
          • Resource
          • v1
      • secret
        • _index
        • v1
          • Secret
          • SecretGroup
          • TrustedSecret
          • UserSecret
          • v1
      • statistics
        • _index
        • plugin
          • Storage
          • plugin
        • v1
          • History
          • Resource
          • Schedule
          • Storage
          • v1
Powered by GitBook
On this page
  • TrustedAccount
  • create
  • update
  • update_secret_data
  • delete
  • sync
  • get
  • list
  • stat
  • Message
  • CreateTrustedAccountRequest
  • Scheduled
  • TrustedAccountInfo
  • TrustedAccountRequest
  • TrustedAccountSearchQuery
  • TrustedAccountStatQuery
  • TrustedAccountsInfo
  • UpdateTrustedAccountRequest
  • UpdateTrustedAccountSecretRequest
  1. content
  2. en
  3. identity
  4. v2

TrustedAccount

Package : spaceone.api.identity.v2

TrustedAccount

TrustedAccount Methods:

Method
Request
Response

create

POST /identity/v2/trusted-account/create

{{< tabs " create " >}}

{{< tab "Request Example" >}}

  • name (string) Required

  • data (Struct) Required

    Base Information of Trusted Account. It depends on provider.

  • provider (string) Required

  • secret_schema_id (string) Required

  • secret_data (Struct) Required

  • resource_group (ResourceGroup) Required

  • schedule (Scheduled)

  • sync_options (Struct)

  • plugin_options (Struct)

  • tags (Struct)

  • workspace_id (string)

{{< highlight json >}} { "name": "Trusted Account", "data": { "account_id": "a1b2c3d4e5f6" }, "provider": "aws", "secret_schema_id": "aws-secret-access-key", "secret_data": { "aws_access_key_id": "a1b2c3d4e5f6", "aws_secret_access_key": "a1b2c3d4e5f6" }, "schedule": { "state": "ENABLED", "hours": [3, 15] }, "resource_group": "DOMAIN" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • trusted_account_id (string) Required

  • name (string) Required

  • data (Struct) Required

  • provider (string) Required

  • schedule (Scheduled) Required

  • sync_options (Struct) Required

  • plugin_options (Struct) Required

  • tags (Struct) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • secret_schema_id (string) Required

  • trusted_secret_id (string) Required

  • created_at (string) Required

{{< highlight json >}} { "created_at": "2024-11-18T07:53:57.897Z", "data": { "account_id": "a1b2c3d4e5f6" }, "domain_id": "domain-a1b2c3d4e5f6", "name": "Trusted Account", "provider": "aws", "resource_group": "DOMAIN", "schedule": { "hours": [3, 15], "state": "ENABLED" }, "secret_schema_id": "aws-secret-access-key", "trusted_account_id": "ta-a1b2c3d4e5f6", "trusted_secret_id": "trusted-secret-a1b2c3d4e5f6", "workspace_id": "*" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

update

POST /identity/v2/trusted-account/update

{{< tabs " update " >}}

{{< tab "Request Example" >}}

  • trusted_account_id (string) Required

  • tags (Struct) Required

  • name (string)

  • data (Struct)

  • schedule (Scheduled)

  • sync_options (Struct)

  • plugin_options (Struct)

{{< highlight json >}} { "trusted_account_id": "ta-a1b2c3d4e5f6", "name": "Trusted Account" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • trusted_account_id (string) Required

  • name (string) Required

  • data (Struct) Required

  • provider (string) Required

  • schedule (Scheduled) Required

  • sync_options (Struct) Required

  • plugin_options (Struct) Required

  • tags (Struct) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • secret_schema_id (string) Required

  • trusted_secret_id (string) Required

  • created_at (string) Required

{{< highlight json >}} { "created_at": "2024-11-18T07:53:57.897Z", "data": { "account_id": "a1b2c3d4e5f6" }, "domain_id": "domain-a1b2c3d4e5f6", "name": "Trusted Account", "provider": "aws", "resource_group": "DOMAIN", "schedule": { "hours": [3, 15], "state": "ENABLED" }, "secret_schema_id": "aws-secret-access-key", "trusted_account_id": "ta-a1b2c3d4e5f6", "trusted_secret_id": "trusted-secret-a1b2c3d4e5f6", "workspace_id": "*" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

update_secret_data

POST /identity/v2/trusted-account/update-secret-data

{{< tabs " update_secret_data " >}}

{{< tab "Request Example" >}}

  • trusted_account_id (string) Required

  • secret_schema_id (string) Required

  • secret_data (Struct) Required

{{< highlight json >}} { "trusted_account_id": "ta-a1b2c3d4e5f6", "secretSchemaId": "aws-secret-access-key", "secretData": { "aws_access_key_id": "a1b2c3d4e5f6", "aws_secret_access_key": "a1b2c3d4e5f6" } } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • trusted_account_id (string) Required

  • name (string) Required

  • data (Struct) Required

  • provider (string) Required

  • schedule (Scheduled) Required

  • sync_options (Struct) Required

  • plugin_options (Struct) Required

  • tags (Struct) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • secret_schema_id (string) Required

  • trusted_secret_id (string) Required

  • created_at (string) Required

{{< highlight json >}} { "created_at": "2024-11-18T07:53:57.897Z", "data": { "account_id": "a1b2c3d4e5f6" }, "domain_id": "domain-a1b2c3d4e5f6", "name": "Trusted Account", "provider": "aws", "resource_group": "DOMAIN", "schedule": { "hours": [3, 15], "state": "ENABLED" }, "secret_schema_id": "aws-secret-access-key", "trusted_account_id": "ta-a1b2c3d4e5f6", "trusted_secret_id": "trusted-secret-a1b2c3d4e5f6", "workspace_id": "*" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

delete

POST /identity/v2/trusted-account/delete

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

  • trusted_account_id (string) Required

{{< highlight json >}} { "trusted_account_id": "ta-a1b2c3d4e5f6" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

sync

POST /identity/v2/trusted-account/sync

{{< tabs " sync " >}}

{{< tab "Request Example" >}}

  • trusted_account_id (string) Required

{{< highlight json >}} { "trusted_account_id": "ta-a1b2c3d4e5f6" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

get

POST /identity/v2/trusted-account/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

  • trusted_account_id (string) Required

{{< highlight json >}} { "trusted_account_id": "ta-a1b2c3d4e5f6" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • trusted_account_id (string) Required

  • name (string) Required

  • data (Struct) Required

  • provider (string) Required

  • schedule (Scheduled) Required

  • sync_options (Struct) Required

  • plugin_options (Struct) Required

  • tags (Struct) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • secret_schema_id (string) Required

  • trusted_secret_id (string) Required

  • created_at (string) Required

{{< highlight json >}} { "created_at": "2024-11-18T07:53:57.897Z", "data": { "account_id": "a1b2c3d4e5f6" }, "domain_id": "domain-a1b2c3d4e5f6", "name": "Trusted Account", "provider": "aws", "resource_group": "DOMAIN", "schedule": { "hours": [3, 15], "state": "ENABLED" }, "secret_schema_id": "aws-secret-access-key", "trusted_account_id": "ta-a1b2c3d4e5f6", "trusted_secret_id": "trusted-secret-a1b2c3d4e5f6", "workspace_id": "*" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

list

POST /identity/v2/trusted-account/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

  • query (Query)

  • trusted_account_id (string)

  • name (string)

  • provider (string)

  • workspace_id (string)

  • secret_schema_id (string)

  • trusted_secret_id (string)

{{< highlight json >}} { "provider": "aws", "query": { "page": { "start": 1, "limit": 10 }, "sort": [ { "key": "created_at", "desc": true } ] } } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • results (TrustedAccountInfo) Repeated Required

  • total_count (int32) Required

{{< highlight json >}} { "results": [ { "created_at": "2024-11-18T07:47:02.789Z", "data": { "account_id": "a1b2c3d4e5f6" }, "domain_id": "domain-a1b2c3d4e5f6", "name": "Trusted Account", "provider": "aws", "resource_group": "DOMAIN", "secret_schema_id": "aws-secret-access-key", "trusted_account_id": "ta-a1b2c3d4e5f6", "trusted_secret_id": "trusted-secret-a1b2c3d4e5f6", "workspace_id": "" }, { "created_at": "2024-11-18T07:10:17.114Z", "data": { "account_id": "g7h8i9j1k2l3" }, "domain_id": "domain-a1b2c3d4e5f6", "name": "Wonny Trusted Account", "provider": "aws", "resource_group": "DOMAIN", "secret_schema_id": "aws-secret-access-key", "trusted_account_id": "ta-g7h8i9j1k2l3", "trusted_secret_id": "trusted-secret-g7h8i9j1k2l3", "workspace_id": "" } ], "total_count": 2 } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

stat

POST /identity/v2/trusted-account/stat

Message

CreateTrustedAccountRequest

  • name (string) Required

  • data (Struct) Required

    Base Information of Trusted Account. It depends on provider.

  • provider (string) Required

  • secret_schema_id (string) Required

  • secret_data (Struct) Required

  • resource_group (ResourceGroup) Required

  • schedule (Scheduled)

  • sync_options (Struct)

  • plugin_options (Struct)

  • tags (Struct)

  • workspace_id (string)

Scheduled

  • state (ScheduledState) Required

  • hours (int32) Repeated Required

TrustedAccountInfo

  • trusted_account_id (string) Required

  • name (string) Required

  • data (Struct) Required

  • provider (string) Required

  • schedule (Scheduled) Required

  • sync_options (Struct) Required

  • plugin_options (Struct) Required

  • tags (Struct) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • secret_schema_id (string) Required

  • trusted_secret_id (string) Required

  • created_at (string) Required

TrustedAccountRequest

  • trusted_account_id (string) Required

TrustedAccountSearchQuery

  • query (Query)

  • trusted_account_id (string)

  • name (string)

  • provider (string)

  • workspace_id (string)

  • secret_schema_id (string)

  • trusted_secret_id (string)

TrustedAccountStatQuery

  • query (StatisticsQuery) Required

TrustedAccountsInfo

  • results (TrustedAccountInfo) Repeated Required

  • total_count (int32) Required

UpdateTrustedAccountRequest

  • trusted_account_id (string) Required

  • tags (Struct) Required

  • name (string)

  • data (Struct)

  • schedule (Scheduled)

  • sync_options (Struct)

  • plugin_options (Struct)

UpdateTrustedAccountSecretRequest

  • trusted_account_id (string) Required

  • secret_schema_id (string) Required

  • secret_data (Struct) Required

PreviousTokenNextTrustedServiceAccount

Last updated 5 months ago

CreateTrustedAccountRequest
UpdateTrustedAccountRequest
UpdateTrustedAccountSecretRequest
TrustedAccountRequest
TrustedAccountRequest
TrustedAccountRequest
TrustedAccountSearchQuery
TrustedAccountInfo
TrustedAccountInfo
TrustedAccountInfo
TrustedAccountInfo
TrustedAccountsInfo
create
CreateTrustedAccountRequest
TrustedAccountInfo
update
UpdateTrustedAccountRequest
TrustedAccountInfo
update_secret_data
UpdateTrustedAccountSecretRequest
TrustedAccountInfo
delete
TrustedAccountRequest
Empty
sync
TrustedAccountRequest
JobInfo
get
TrustedAccountRequest
TrustedAccountInfo
list
TrustedAccountSearchQuery
TrustedAccountsInfo
stat
TrustedAccountStatQuery
Struct