@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
116 lines • 4.47 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* SCIM Token resource allows you to create and manage SCIM tokens for SCIM configurations.
*
* SCIM tokens are used to authenticate to SCIM endpoints for automated user provisioning and management. Each token is associated with a specific SCIM configuration and has an expiration time.
*
* > **Note:** The bearer token is only available at creation time and is marked as sensitive. It cannot be retrieved after creation. If you lose the token, you will need to create a new one.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* //## Basic SCIM Token creation
* // Enable SCIM for your organization
* const main = new scaleway.iam.Scim("main", {organizationId: "your-organization-id"});
* // Create a SCIM token
* const mainScimToken = new scaleway.iam.ScimToken("main", {
* scimId: main.id,
* organizationId: "your-organization-id",
* });
* ```
*
* ## Import
*
* SCIM token can be imported using the token ID. The organization ID will be set to the default organization configured in the provider.
*
* ```sh
* $ pulumi import scaleway:iam/scimToken:ScimToken main 11111111-1111-1111-1111-111111111111
* ```
*/
export declare class ScimToken extends pulumi.CustomResource {
/**
* Get an existing ScimToken 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?: ScimTokenState, opts?: pulumi.CustomResourceOptions): ScimToken;
/**
* Returns true if the given object is an instance of ScimToken. 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 ScimToken;
/**
* The Bearer Token to use to authenticate to SCIM endpoints.
*/
readonly bearerToken: pulumi.Output<string>;
/**
* The date and time of SCIM token creation
*/
readonly createdAt: pulumi.Output<string>;
/**
* The date and time when the SCIM token expires
*/
readonly expiresAt: pulumi.Output<string>;
/**
* The organization ID. If not provided, the default organization configured in the provider is used.
*/
readonly organizationId: pulumi.Output<string>;
/**
* The SCIM configuration ID for which to create the token.
*/
readonly scimId: pulumi.Output<string>;
/**
* Create a ScimToken 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: ScimTokenArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ScimToken resources.
*/
export interface ScimTokenState {
/**
* The Bearer Token to use to authenticate to SCIM endpoints.
*/
bearerToken?: pulumi.Input<string | undefined>;
/**
* The date and time of SCIM token creation
*/
createdAt?: pulumi.Input<string | undefined>;
/**
* The date and time when the SCIM token expires
*/
expiresAt?: pulumi.Input<string | undefined>;
/**
* The organization ID. If not provided, the default organization configured in the provider is used.
*/
organizationId?: pulumi.Input<string | undefined>;
/**
* The SCIM configuration ID for which to create the token.
*/
scimId?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a ScimToken resource.
*/
export interface ScimTokenArgs {
/**
* The organization ID. If not provided, the default organization configured in the provider is used.
*/
organizationId?: pulumi.Input<string | undefined>;
/**
* The SCIM configuration ID for which to create the token.
*/
scimId: pulumi.Input<string>;
}
//# sourceMappingURL=scimToken.d.ts.map