Skip to main content

Auth

Resource Auth in pulumi-portainer.
2 min read

Resource Auth in pulumi-portainer.

Pulumi type: portainer:index/auth:Auth.

name is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

Example#

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

Arguments#

PropertyTypeRequiredDescription
authIdstringno
passwordstringyesPassword used to authenticate against the Portainer API. Stored in state as a sensitive value. Changing this value forces resource recreation.
usernamestringyesUsername used to authenticate against the Portainer API. Stored in state as a sensitive value. Changing this value forces resource recreation.

Outputs#

Computed outputs are produced by the provider. They are not constructor arguments.

PropertyTypeComputedDescription
authIdstringno
jwtstringyesJWT bearer token issued by Portainer after successful authentication. Computed and stored in state as a sensitive value.
passwordstringnoPassword used to authenticate against the Portainer API. Stored in state as a sensitive value. Changing this value forces resource recreation.
usernamestringnoUsername used to authenticate against the Portainer API. Stored in state as a sensitive value. Changing this value forces resource recreation.