• HashiCorp Developer

  • HashiCorp Cloud Platform
  • Terraform
  • Packer
  • Consul
  • Vault
  • Boundary
  • Nomad
  • Waypoint
  • Vagrant
Boundary
  • Install
  • Tutorials
  • Documentation
  • API
  • Try Cloud(opens in new tab)
  • Sign up
Boundary Home

API

Skip to main content
  • API

  • Account Service
  • Auth Method Service
  • Auth Token Service
  • Credential Library Service
  • Credential Service
  • Credential Store Service
  • Group Service
  • Host Catalog Service
  • Host Service
  • Host Set Service
  • Managed Group Service
  • Role Service
  • Scope Service
  • Session Service
  • Target Service
  • User Service
  • Worker Service

  • Resources

  • Tutorial Library
  • Community Forum
    (opens in new tab)
  • Support
    (opens in new tab)
  • GitHub
    (opens in new tab)
  1. Developer
  2. Boundary
  3. API
  4. Target Service

Boundary Controller HTTP API

Target Service


Lists all Targets.

Query Parameters

scope_id string
recursive boolean
filter string

Successful Response


id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.


id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Required name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of the Target.

host_source_ids string[]

id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Source belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

brokered_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

injected_application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]

Creates a single Target.

Body Parameters

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.

name string

Required name for identification purposes.

description string

Optional user-set description for identification purposes.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of the Target.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

attributes object

The attributes that are applicable for the specific Target.

Successful Response

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.


id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Required name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of the Target.

host_source_ids string[]

id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Source belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

brokered_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

injected_application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]

Gets a single Target.

Path Parameters

id string RequiredRequired

Successful Response

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.


id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Required name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of the Target.

host_source_ids string[]

id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Source belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

brokered_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

injected_application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]

Deletes a Target.

Path Parameters

id string RequiredRequired

Successful Response

No content.

Updates a Target.

Path Parameters

id string RequiredRequired

Query Parameters

update_mask string

Body Parameters

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.

name string

Required name for identification purposes.

description string

Optional user-set description for identification purposes.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of the Target.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

attributes object

The attributes that are applicable for the specific Target.

Successful Response

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.


id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Required name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of the Target.

host_source_ids string[]

id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Source belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

brokered_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

injected_application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]

Adds existing Credential Sources to a Target.

Path Parameters

id string RequiredRequired

Body Parameters

version integer

Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

application_credential_source_ids string[]
brokered_credential_source_ids string[]
injected_application_credential_source_ids string[]

Successful Response

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.


id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Required name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of the Target.

host_source_ids string[]

id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Source belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

brokered_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

injected_application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]

Adds existing Host Sources to a Target.

Path Parameters

id string RequiredRequired

Body Parameters

version integer

Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

host_source_ids string[]

Successful Response

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.


id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Required name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of the Target.

host_source_ids string[]

id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Source belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

brokered_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

injected_application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]

Authorizes a Session.

Path Parameters

id string RequiredRequired

The ID of the target. Required unless some combination of scope_id/scope_name and name are set.

Body Parameters

name string

The name of the target. When using this, scope_id or scope_name must be set.

scope_id string

The scope ID containing the target, if specifying the target by name.

scope_name string

The scope name containing the target, if specifying the target by name.

host_id string

An optional parameter allowing specification of the particular Host within the Target's configured Host Sets to connect to during this Session.

Successful Response

session_id string

Output only. The ID of the Session.

target_id string

Output only. The ID of the Target authorizing this Session.


id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

created_time string

Output only. The time this resource was created.

user_id string

Output only. The User for which this Session was authorized.

host_set_id string

Output only. The Host Set containing the Host being used for this Session.

host_id string

Output only. The Host whose address is being used as the endpoint for this Session.

type string

Output only. Type of the Session (e.g. tcp, ssh, etc.).

authorization_token string

Output only. The marshaled SessionAuthorizationData message containing all information that the proxy needs.

endpoint string

Output only. The endpoint address that the worker will connect to, useful for setting TLS parameters.



id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.


raw string

Output only. The base64-encoded value representing the raw bytes from the credential provider.

decoded object

Output only. The decoded raw string, if a JSON object.

credential object

Output only. The fields of the strongly typed credential, empty if the credential type of the credential source is unspecified.


Removes Credential Sources from the Target.

Path Parameters

id string RequiredRequired

Body Parameters

version integer

Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

application_credential_source_ids string[]
brokered_credential_source_ids string[]
injected_application_credential_source_ids string[]

Successful Response

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.


id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Required name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of the Target.

host_source_ids string[]

id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Source belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

brokered_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

injected_application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]

Removes Host Sources from the Target.

Path Parameters

id string RequiredRequired

Body Parameters

version integer

Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

host_source_ids string[]

Successful Response

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.


id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Required name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of the Target.

host_source_ids string[]

id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Source belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

brokered_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

injected_application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]

Sets the Credential Sources on the Target.

Path Parameters

id string RequiredRequired

Body Parameters

version integer

Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

application_credential_source_ids string[]
brokered_credential_source_ids string[]
injected_application_credential_source_ids string[]

Successful Response

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.


id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Required name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of the Target.

host_source_ids string[]

id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Source belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

brokered_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

injected_application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]

Sources the Host Sources on the Target.

Path Parameters

id string RequiredRequired

Body Parameters

version integer

Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

host_source_ids string[]

Successful Response

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.


id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Required name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of the Target.

host_source_ids string[]

id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Source belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

brokered_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

injected_application_credential_source_ids string[]

id string

The ID of the Credential. May be empty if the credential is dynamically generated from a library.

name string

Output only. The name of the Credential source.

description string

Output only. The description of the Credential source.

credential_store_id string

Output only. The Credential Store to which this Credential source belongs.

type string

Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).

credential_type string

Output only. The type of the credential, empty if unspecified.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]
Give Feedback(opens in new tab)
  • Certifications
  • System Status
  • Terms of Use
  • Security
  • Privacy
  • Trademark Policy
  • Trade Controls
  • Give Feedback(opens in new tab)