@pulumi/juniper-mist/org/apitoken.d.ts

A Pulumi package for creating and managing Juniper Mist resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * This resource manages Org API Tokens.
 *
 * An Org API token is a unique identifier used by an application to authenticate and access the Mist APIs. These tokens are used to authenticate requests made to the API server and ensure secure access to the API. They are not bound to any specific user and provide access to the organization as a whole.
 * Organization tokens support different privileges and can only be used for the specific organization they are generated for.
 * Rate limiting is done on an individual token basis, so if one token reaches its rate limit, it does not impact other tokens.
 */
export declare class Apitoken extends pulumi.CustomResource {
    /**
     * Get an existing Apitoken resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApitokenState, opts?: pulumi.CustomResourceOptions): Apitoken;
    /**
     * Returns true if the given object is an instance of Apitoken.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is Apitoken;
    /**
     * email of the token creator / null if creator is deleted
     */
    readonly createdBy: pulumi.Output<string>;
    readonly key: pulumi.Output<string>;
    /**
     * Name of the token
     */
    readonly name: pulumi.Output<string>;
    readonly orgId: pulumi.Output<string>;
    /**
     * List of privileges the token has on the orgs/sites
     */
    readonly privileges: pulumi.Output<outputs.org.ApitokenPrivilege[]>;
    /**
     * List of allowed IP addresses from where the token can be used from. At most 10 IP addresses can be specified, cannot be changed once the API Token is created.
     */
    readonly srcIps: pulumi.Output<string[] | undefined>;
    /**
     * Create a Apitoken resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: ApitokenArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Apitoken resources.
 */
export interface ApitokenState {
    /**
     * email of the token creator / null if creator is deleted
     */
    createdBy?: pulumi.Input<string>;
    key?: pulumi.Input<string>;
    /**
     * Name of the token
     */
    name?: pulumi.Input<string>;
    orgId?: pulumi.Input<string>;
    /**
     * List of privileges the token has on the orgs/sites
     */
    privileges?: pulumi.Input<pulumi.Input<inputs.org.ApitokenPrivilege>[]>;
    /**
     * List of allowed IP addresses from where the token can be used from. At most 10 IP addresses can be specified, cannot be changed once the API Token is created.
     */
    srcIps?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
 * The set of arguments for constructing a Apitoken resource.
 */
export interface ApitokenArgs {
    /**
     * Name of the token
     */
    name?: pulumi.Input<string>;
    orgId: pulumi.Input<string>;
    /**
     * List of privileges the token has on the orgs/sites
     */
    privileges: pulumi.Input<pulumi.Input<inputs.org.ApitokenPrivilege>[]>;
    /**
     * List of allowed IP addresses from where the token can be used from. At most 10 IP addresses can be specified, cannot be changed once the API Token is created.
     */
    srcIps?: pulumi.Input<pulumi.Input<string>[]>;
}