1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. getApiuser
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.system.getApiuser

Explore with Pulumi AI

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

Use this data source to get information on an fortios system apiuser

Using getApiuser

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getApiuser(args: GetApiuserArgs, opts?: InvokeOptions): Promise<GetApiuserResult>
function getApiuserOutput(args: GetApiuserOutputArgs, opts?: InvokeOptions): Output<GetApiuserResult>
Copy
def get_apiuser(name: Optional[str] = None,
                vdomparam: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetApiuserResult
def get_apiuser_output(name: Optional[pulumi.Input[str]] = None,
                vdomparam: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetApiuserResult]
Copy
func LookupApiuser(ctx *Context, args *LookupApiuserArgs, opts ...InvokeOption) (*LookupApiuserResult, error)
func LookupApiuserOutput(ctx *Context, args *LookupApiuserOutputArgs, opts ...InvokeOption) LookupApiuserResultOutput
Copy

> Note: This function is named LookupApiuser in the Go SDK.

public static class GetApiuser 
{
    public static Task<GetApiuserResult> InvokeAsync(GetApiuserArgs args, InvokeOptions? opts = null)
    public static Output<GetApiuserResult> Invoke(GetApiuserInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetApiuserResult> getApiuser(GetApiuserArgs args, InvokeOptions options)
public static Output<GetApiuserResult> getApiuser(GetApiuserArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: fortios:system/getApiuser:getApiuser
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Specify the name of the desired system apiuser.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
Name This property is required. string
Specify the name of the desired system apiuser.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
name This property is required. String
Specify the name of the desired system apiuser.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
name This property is required. string
Specify the name of the desired system apiuser.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
name This property is required. str
Specify the name of the desired system apiuser.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
name This property is required. String
Specify the name of the desired system apiuser.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

getApiuser Result

The following output properties are available:

Accprofile string
Admin user access profile.
ApiKey string
Admin user password.
Comments string
Comment.
CorsAllowOrigin string
Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Virtual domain name.
PeerAuth string
Enable/disable peer authentication.
PeerGroup string
Peer group name.
Schedule string
Schedule name.
Trusthosts List<Pulumiverse.Fortios.System.Outputs.GetApiuserTrusthost>
Trusthost. The structure of trusthost block is documented below.
Vdoms List<Pulumiverse.Fortios.System.Outputs.GetApiuserVdom>
Virtual domains. The structure of vdom block is documented below.
Vdomparam string
Accprofile string
Admin user access profile.
ApiKey string
Admin user password.
Comments string
Comment.
CorsAllowOrigin string
Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Virtual domain name.
PeerAuth string
Enable/disable peer authentication.
PeerGroup string
Peer group name.
Schedule string
Schedule name.
Trusthosts []GetApiuserTrusthost
Trusthost. The structure of trusthost block is documented below.
Vdoms []GetApiuserVdom
Virtual domains. The structure of vdom block is documented below.
Vdomparam string
accprofile String
Admin user access profile.
apiKey String
Admin user password.
comments String
Comment.
corsAllowOrigin String
Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
id String
The provider-assigned unique ID for this managed resource.
name String
Virtual domain name.
peerAuth String
Enable/disable peer authentication.
peerGroup String
Peer group name.
schedule String
Schedule name.
trusthosts List<GetApiuserTrusthost>
Trusthost. The structure of trusthost block is documented below.
vdoms List<GetApiuserVdom>
Virtual domains. The structure of vdom block is documented below.
vdomparam String
accprofile string
Admin user access profile.
apiKey string
Admin user password.
comments string
Comment.
corsAllowOrigin string
Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
id string
The provider-assigned unique ID for this managed resource.
name string
Virtual domain name.
peerAuth string
Enable/disable peer authentication.
peerGroup string
Peer group name.
schedule string
Schedule name.
trusthosts GetApiuserTrusthost[]
Trusthost. The structure of trusthost block is documented below.
vdoms GetApiuserVdom[]
Virtual domains. The structure of vdom block is documented below.
vdomparam string
accprofile str
Admin user access profile.
api_key str
Admin user password.
comments str
Comment.
cors_allow_origin str
Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
id str
The provider-assigned unique ID for this managed resource.
name str
Virtual domain name.
peer_auth str
Enable/disable peer authentication.
peer_group str
Peer group name.
schedule str
Schedule name.
trusthosts Sequence[GetApiuserTrusthost]
Trusthost. The structure of trusthost block is documented below.
vdoms Sequence[GetApiuserVdom]
Virtual domains. The structure of vdom block is documented below.
vdomparam str
accprofile String
Admin user access profile.
apiKey String
Admin user password.
comments String
Comment.
corsAllowOrigin String
Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
id String
The provider-assigned unique ID for this managed resource.
name String
Virtual domain name.
peerAuth String
Enable/disable peer authentication.
peerGroup String
Peer group name.
schedule String
Schedule name.
trusthosts List<Property Map>
Trusthost. The structure of trusthost block is documented below.
vdoms List<Property Map>
Virtual domains. The structure of vdom block is documented below.
vdomparam String

Supporting Types

GetApiuserTrusthost

Id This property is required. int
Table ID.
Ipv4Trusthost This property is required. string
IPv4 trusted host address.
Ipv6Trusthost This property is required. string
IPv6 trusted host address.
Type This property is required. string
Trusthost type.
Id This property is required. int
Table ID.
Ipv4Trusthost This property is required. string
IPv4 trusted host address.
Ipv6Trusthost This property is required. string
IPv6 trusted host address.
Type This property is required. string
Trusthost type.
id This property is required. Integer
Table ID.
ipv4Trusthost This property is required. String
IPv4 trusted host address.
ipv6Trusthost This property is required. String
IPv6 trusted host address.
type This property is required. String
Trusthost type.
id This property is required. number
Table ID.
ipv4Trusthost This property is required. string
IPv4 trusted host address.
ipv6Trusthost This property is required. string
IPv6 trusted host address.
type This property is required. string
Trusthost type.
id This property is required. int
Table ID.
ipv4_trusthost This property is required. str
IPv4 trusted host address.
ipv6_trusthost This property is required. str
IPv6 trusted host address.
type This property is required. str
Trusthost type.
id This property is required. Number
Table ID.
ipv4Trusthost This property is required. String
IPv4 trusted host address.
ipv6Trusthost This property is required. String
IPv6 trusted host address.
type This property is required. String
Trusthost type.

GetApiuserVdom

Name This property is required. string
Specify the name of the desired system apiuser.
Name This property is required. string
Specify the name of the desired system apiuser.
name This property is required. String
Specify the name of the desired system apiuser.
name This property is required. string
Specify the name of the desired system apiuser.
name This property is required. str
Specify the name of the desired system apiuser.
name This property is required. String
Specify the name of the desired system apiuser.

Package Details

Repository
fortios pulumiverse/pulumi-fortios
License
Apache-2.0
Notes
This Pulumi package is based on the fortios Terraform Provider.
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse