1. Packages
  2. InfluxDB V3
  3. API Docs
  4. getToken
InfluxDB3 v1.2.3 published on Sunday, Sep 29, 2024 by komminarlabs

influxdb3.getToken

Explore with Pulumi AI

influxdb3 logo
InfluxDB3 v1.2.3 published on Sunday, Sep 29, 2024 by komminarlabs

    Gets a database token. Use this data source to retrieve information about a database token, including the token’s permissions.

    Using getToken

    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 getToken(args: GetTokenArgs, opts?: InvokeOptions): Promise<GetTokenResult>
    function getTokenOutput(args: GetTokenOutputArgs, opts?: InvokeOptions): Output<GetTokenResult>
    def get_token(id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetTokenResult
    def get_token_output(id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetTokenResult]
    func LookupToken(ctx *Context, args *LookupTokenArgs, opts ...InvokeOption) (*LookupTokenResult, error)
    func LookupTokenOutput(ctx *Context, args *LookupTokenOutputArgs, opts ...InvokeOption) LookupTokenResultOutput

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

    public static class GetToken 
    {
        public static Task<GetTokenResult> InvokeAsync(GetTokenArgs args, InvokeOptions? opts = null)
        public static Output<GetTokenResult> Invoke(GetTokenInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTokenResult> getToken(GetTokenArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: influxdb3:index/getToken:getToken
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of the database token.
    Id string
    The ID of the database token.
    id String
    The ID of the database token.
    id string
    The ID of the database token.
    id str
    The ID of the database token.
    id String
    The ID of the database token.

    getToken Result

    The following output properties are available:

    AccessToken string
    The access token that can be used to authenticate query and write requests to the cluster. The access token is never stored by InfluxDB and is only returned once when the token is created. If the access token is lost, a new token must be created.
    AccountId string
    The ID of the account that the database token belongs to.
    ClusterId string
    The ID of the cluster that the database token belongs to.
    CreatedAt string
    The date and time that the database token was created. Uses RFC3339 format.
    Description string
    The description of the database token.
    Id string
    The ID of the database token.
    Permissions List<KomminarLabs.InfluxDB3.Outputs.GetTokenPermission>
    The list of permissions the database token allows.
    AccessToken string
    The access token that can be used to authenticate query and write requests to the cluster. The access token is never stored by InfluxDB and is only returned once when the token is created. If the access token is lost, a new token must be created.
    AccountId string
    The ID of the account that the database token belongs to.
    ClusterId string
    The ID of the cluster that the database token belongs to.
    CreatedAt string
    The date and time that the database token was created. Uses RFC3339 format.
    Description string
    The description of the database token.
    Id string
    The ID of the database token.
    Permissions []GetTokenPermission
    The list of permissions the database token allows.
    accessToken String
    The access token that can be used to authenticate query and write requests to the cluster. The access token is never stored by InfluxDB and is only returned once when the token is created. If the access token is lost, a new token must be created.
    accountId String
    The ID of the account that the database token belongs to.
    clusterId String
    The ID of the cluster that the database token belongs to.
    createdAt String
    The date and time that the database token was created. Uses RFC3339 format.
    description String
    The description of the database token.
    id String
    The ID of the database token.
    permissions List<GetTokenPermission>
    The list of permissions the database token allows.
    accessToken string
    The access token that can be used to authenticate query and write requests to the cluster. The access token is never stored by InfluxDB and is only returned once when the token is created. If the access token is lost, a new token must be created.
    accountId string
    The ID of the account that the database token belongs to.
    clusterId string
    The ID of the cluster that the database token belongs to.
    createdAt string
    The date and time that the database token was created. Uses RFC3339 format.
    description string
    The description of the database token.
    id string
    The ID of the database token.
    permissions GetTokenPermission[]
    The list of permissions the database token allows.
    access_token str
    The access token that can be used to authenticate query and write requests to the cluster. The access token is never stored by InfluxDB and is only returned once when the token is created. If the access token is lost, a new token must be created.
    account_id str
    The ID of the account that the database token belongs to.
    cluster_id str
    The ID of the cluster that the database token belongs to.
    created_at str
    The date and time that the database token was created. Uses RFC3339 format.
    description str
    The description of the database token.
    id str
    The ID of the database token.
    permissions Sequence[GetTokenPermission]
    The list of permissions the database token allows.
    accessToken String
    The access token that can be used to authenticate query and write requests to the cluster. The access token is never stored by InfluxDB and is only returned once when the token is created. If the access token is lost, a new token must be created.
    accountId String
    The ID of the account that the database token belongs to.
    clusterId String
    The ID of the cluster that the database token belongs to.
    createdAt String
    The date and time that the database token was created. Uses RFC3339 format.
    description String
    The description of the database token.
    id String
    The ID of the database token.
    permissions List<Property Map>
    The list of permissions the database token allows.

    Supporting Types

    GetTokenPermission

    Action string
    The action the database token permission allows.
    Resource string
    The resource the database token permission applies to. * refers to all databases.
    Action string
    The action the database token permission allows.
    Resource string
    The resource the database token permission applies to. * refers to all databases.
    action String
    The action the database token permission allows.
    resource String
    The resource the database token permission applies to. * refers to all databases.
    action string
    The action the database token permission allows.
    resource string
    The resource the database token permission applies to. * refers to all databases.
    action str
    The action the database token permission allows.
    resource str
    The resource the database token permission applies to. * refers to all databases.
    action String
    The action the database token permission allows.
    resource String
    The resource the database token permission applies to. * refers to all databases.

    Package Details

    Repository
    influxdb3 komminarlabs/pulumi-influxdb3
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the influxdb3 Terraform Provider.
    influxdb3 logo
    InfluxDB3 v1.2.3 published on Sunday, Sep 29, 2024 by komminarlabs