1. Packages
  2. InfluxDB
  3. API Docs
  4. getAuthorization
InfluxDB v1.3.0 published on Monday, Mar 10, 2025 by komminarlabs

influxdb.getAuthorization

Explore with Pulumi AI

InfluxDB v1.3.0 published on Monday, Mar 10, 2025 by komminarlabs

Retrieves an authorization. Use this data source to retrieve information about an API token, including the token’s permissions and the user that the token is scoped to.

Using getAuthorization

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 getAuthorization(args: GetAuthorizationArgs, opts?: InvokeOptions): Promise<GetAuthorizationResult>
function getAuthorizationOutput(args: GetAuthorizationOutputArgs, opts?: InvokeOptions): Output<GetAuthorizationResult>
Copy
def get_authorization(id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetAuthorizationResult
def get_authorization_output(id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetAuthorizationResult]
Copy
func LookupAuthorization(ctx *Context, args *LookupAuthorizationArgs, opts ...InvokeOption) (*LookupAuthorizationResult, error)
func LookupAuthorizationOutput(ctx *Context, args *LookupAuthorizationOutputArgs, opts ...InvokeOption) LookupAuthorizationResultOutput
Copy

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

public static class GetAuthorization 
{
    public static Task<GetAuthorizationResult> InvokeAsync(GetAuthorizationArgs args, InvokeOptions? opts = null)
    public static Output<GetAuthorizationResult> Invoke(GetAuthorizationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAuthorizationResult> getAuthorization(GetAuthorizationArgs args, InvokeOptions options)
public static Output<GetAuthorizationResult> getAuthorization(GetAuthorizationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: influxdb:index/getAuthorization:getAuthorization
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The authorization ID.
Id This property is required. string
The authorization ID.
id This property is required. String
The authorization ID.
id This property is required. string
The authorization ID.
id This property is required. str
The authorization ID.
id This property is required. String
The authorization ID.

getAuthorization Result

The following output properties are available:

CreatedAt string
Authorization creation date.
Description string
A description of the token.
Id string
The authorization ID.
Org string
Organization name. Specifies the organization that owns the authorization.
OrgId string
An organization ID. Specifies the organization that owns the authorization.
Permissions List<KomminarLabs.InfluxDB.Outputs.GetAuthorizationPermission>
A list of permissions for an authorization.
Status string
Status of the token.
Token string
The API token.
UpdatedAt string
Last Authorization update date.
User string
A user name. Specifies the user that the authorization is scoped to.
UserId string
A user ID. Specifies the user that the authorization is scoped to.
CreatedAt string
Authorization creation date.
Description string
A description of the token.
Id string
The authorization ID.
Org string
Organization name. Specifies the organization that owns the authorization.
OrgId string
An organization ID. Specifies the organization that owns the authorization.
Permissions []GetAuthorizationPermission
A list of permissions for an authorization.
Status string
Status of the token.
Token string
The API token.
UpdatedAt string
Last Authorization update date.
User string
A user name. Specifies the user that the authorization is scoped to.
UserId string
A user ID. Specifies the user that the authorization is scoped to.
createdAt String
Authorization creation date.
description String
A description of the token.
id String
The authorization ID.
org String
Organization name. Specifies the organization that owns the authorization.
orgId String
An organization ID. Specifies the organization that owns the authorization.
permissions List<GetAuthorizationPermission>
A list of permissions for an authorization.
status String
Status of the token.
token String
The API token.
updatedAt String
Last Authorization update date.
user String
A user name. Specifies the user that the authorization is scoped to.
userId String
A user ID. Specifies the user that the authorization is scoped to.
createdAt string
Authorization creation date.
description string
A description of the token.
id string
The authorization ID.
org string
Organization name. Specifies the organization that owns the authorization.
orgId string
An organization ID. Specifies the organization that owns the authorization.
permissions GetAuthorizationPermission[]
A list of permissions for an authorization.
status string
Status of the token.
token string
The API token.
updatedAt string
Last Authorization update date.
user string
A user name. Specifies the user that the authorization is scoped to.
userId string
A user ID. Specifies the user that the authorization is scoped to.
created_at str
Authorization creation date.
description str
A description of the token.
id str
The authorization ID.
org str
Organization name. Specifies the organization that owns the authorization.
org_id str
An organization ID. Specifies the organization that owns the authorization.
permissions Sequence[GetAuthorizationPermission]
A list of permissions for an authorization.
status str
Status of the token.
token str
The API token.
updated_at str
Last Authorization update date.
user str
A user name. Specifies the user that the authorization is scoped to.
user_id str
A user ID. Specifies the user that the authorization is scoped to.
createdAt String
Authorization creation date.
description String
A description of the token.
id String
The authorization ID.
org String
Organization name. Specifies the organization that owns the authorization.
orgId String
An organization ID. Specifies the organization that owns the authorization.
permissions List<Property Map>
A list of permissions for an authorization.
status String
Status of the token.
token String
The API token.
updatedAt String
Last Authorization update date.
user String
A user name. Specifies the user that the authorization is scoped to.
userId String
A user ID. Specifies the user that the authorization is scoped to.

Supporting Types

GetAuthorizationPermission

Action This property is required. string
Permission action.
Resource This property is required. KomminarLabs.InfluxDB.Inputs.GetAuthorizationPermissionResource
Action This property is required. string
Permission action.
Resource This property is required. GetAuthorizationPermissionResource
action This property is required. String
Permission action.
resource This property is required. GetAuthorizationPermissionResource
action This property is required. string
Permission action.
resource This property is required. GetAuthorizationPermissionResource
action This property is required. str
Permission action.
resource This property is required. GetAuthorizationPermissionResource
action This property is required. String
Permission action.
resource This property is required. Property Map

GetAuthorizationPermissionResource

Id This property is required. string
A resource ID. Identifies a specific resource.
Name This property is required. string
The name of the resource. Note: not all resource types have a name property.
Org This property is required. string
An organization name. The organization that owns the resource.
OrgId This property is required. string
An organization ID. Identifies the organization that owns the resource.
Type This property is required. string
A resource type. Identifies the API resource's type (or kind).
Id This property is required. string
A resource ID. Identifies a specific resource.
Name This property is required. string
The name of the resource. Note: not all resource types have a name property.
Org This property is required. string
An organization name. The organization that owns the resource.
OrgId This property is required. string
An organization ID. Identifies the organization that owns the resource.
Type This property is required. string
A resource type. Identifies the API resource's type (or kind).
id This property is required. String
A resource ID. Identifies a specific resource.
name This property is required. String
The name of the resource. Note: not all resource types have a name property.
org This property is required. String
An organization name. The organization that owns the resource.
orgId This property is required. String
An organization ID. Identifies the organization that owns the resource.
type This property is required. String
A resource type. Identifies the API resource's type (or kind).
id This property is required. string
A resource ID. Identifies a specific resource.
name This property is required. string
The name of the resource. Note: not all resource types have a name property.
org This property is required. string
An organization name. The organization that owns the resource.
orgId This property is required. string
An organization ID. Identifies the organization that owns the resource.
type This property is required. string
A resource type. Identifies the API resource's type (or kind).
id This property is required. str
A resource ID. Identifies a specific resource.
name This property is required. str
The name of the resource. Note: not all resource types have a name property.
org This property is required. str
An organization name. The organization that owns the resource.
org_id This property is required. str
An organization ID. Identifies the organization that owns the resource.
type This property is required. str
A resource type. Identifies the API resource's type (or kind).
id This property is required. String
A resource ID. Identifies a specific resource.
name This property is required. String
The name of the resource. Note: not all resource types have a name property.
org This property is required. String
An organization name. The organization that owns the resource.
orgId This property is required. String
An organization ID. Identifies the organization that owns the resource.
type This property is required. String
A resource type. Identifies the API resource's type (or kind).

Package Details

Repository
influxdb komminarlabs/pulumi-influxdb
License
Apache-2.0
Notes
This Pulumi package is based on the influxdb Terraform Provider.
InfluxDB v1.3.0 published on Monday, Mar 10, 2025 by komminarlabs