Secret Parameters

Copyright (C) 2023 Cadence Design Systems, Inc. (Cadence)

class orionplatform.parameters.secrets.SecretInputParameter(name: str | None = None, title: str | None = None, default=None, null: bool = False, help_text: str = '', promoted: bool = False, promoted_name: str | None = None, required: bool = False, hidden: bool = False, value=None, static: bool = False, max_value=None, min_value=None, max_length=None, choices=None, level='basic', description: str = '', many: bool = False, order: int | None = None)

Bases: floe.api.parameters.BaseParameter

SecretInputParameter can be a single secret IDENTIFIER, or a dictionary. Secrets refer to data in Orion, using Secrets will require an authenticated OrionSession.

IDENTIFIER

or

{SOURCE: [{"id": IDENTIFIER}]}

Parameters:

IDENTIFIER
    an integer

SOURCE
    "secrets"

Example:

{
  "secrets": [
    {
      "id": 9,
    },
    {
      "id": 10,
    },
  ]
}

Returns:

orionplatform.parameters.SecretStream

SecretStream can be used as an iterator to get the secrets specified by the parameter.

class orionplatform.parameters.secrets.SecretStream(obj, session=None, required=False, fieldlist: List[str] | None = None)

Provides an iterator of Orion Client Secrets objects.

SecretStream is tightly coupled to SecretInputParameter and is not intended to be used separately.