@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
125 lines • 4.62 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Get information about a SCIM token.
*
* SCIM (System for Cross-domain Identity Management) tokens are used to authenticate API requests to SCIM endpoints for user provisioning and management.
*
* This data source allows you to retrieve information about an existing SCIM token, including its creation and expiration dates. Note that the bearer token is only available at creation time and cannot be retrieved through this data source.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* //## Get information about a SCIM token
* // First, enable SCIM for your organization
* const mainScim = new scaleway.iam.Scim("main", {organizationId: "11111111-1111-1111-1111-111111111111"});
* // Create a SCIM token (or use an existing one)
* const mainScimToken = new scaleway.iam.ScimToken("main", {
* scimId: mainScim.id,
* organizationId: "11111111-1111-1111-1111-111111111111",
* });
* // Get information about the SCIM token
* const main = scaleway.iam.getScimTokenOutput({
* scimId: mainScim.id,
* tokenId: mainScimToken.id,
* organizationId: "11111111-1111-1111-1111-111111111111",
* });
* ```
*/
export declare function getScimToken(args: GetScimTokenArgs, opts?: pulumi.InvokeOptions): Promise<GetScimTokenResult>;
/**
* A collection of arguments for invoking getScimToken.
*/
export interface GetScimTokenArgs {
/**
* The organization ID. If not provided, the default organization configured in the provider is used.
*/
organizationId?: string;
/**
* The SCIM configuration ID. If not provided, the SCIM configuration for the organization is used.
*/
scimId?: string;
/**
* The ID of the SCIM token to retrieve.
*/
tokenId: string;
}
/**
* A collection of values returned by getScimToken.
*/
export interface GetScimTokenResult {
/**
* The date and time of SCIM token creation
*/
readonly createdAt: string;
/**
* The date and time when the SCIM token expires
*/
readonly expiresAt: string;
/**
* The ID of the SCIM token
*/
readonly id: string;
/**
* The organization ID. If not provided, the default organization configured in the provider is used.
*/
readonly organizationId: string;
/**
* The SCIM configuration ID. If not provided, the SCIM configuration for the organization is used.
*/
readonly scimId: string;
/**
* The ID of the SCIM token to retrieve.
*/
readonly tokenId: string;
}
/**
* Get information about a SCIM token.
*
* SCIM (System for Cross-domain Identity Management) tokens are used to authenticate API requests to SCIM endpoints for user provisioning and management.
*
* This data source allows you to retrieve information about an existing SCIM token, including its creation and expiration dates. Note that the bearer token is only available at creation time and cannot be retrieved through this data source.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* //## Get information about a SCIM token
* // First, enable SCIM for your organization
* const mainScim = new scaleway.iam.Scim("main", {organizationId: "11111111-1111-1111-1111-111111111111"});
* // Create a SCIM token (or use an existing one)
* const mainScimToken = new scaleway.iam.ScimToken("main", {
* scimId: mainScim.id,
* organizationId: "11111111-1111-1111-1111-111111111111",
* });
* // Get information about the SCIM token
* const main = scaleway.iam.getScimTokenOutput({
* scimId: mainScim.id,
* tokenId: mainScimToken.id,
* organizationId: "11111111-1111-1111-1111-111111111111",
* });
* ```
*/
export declare function getScimTokenOutput(args: GetScimTokenOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetScimTokenResult>;
/**
* A collection of arguments for invoking getScimToken.
*/
export interface GetScimTokenOutputArgs {
/**
* The organization ID. If not provided, the default organization configured in the provider is used.
*/
organizationId?: pulumi.Input<string | undefined>;
/**
* The SCIM configuration ID. If not provided, the SCIM configuration for the organization is used.
*/
scimId?: pulumi.Input<string | undefined>;
/**
* The ID of the SCIM token to retrieve.
*/
tokenId: pulumi.Input<string>;
}
//# sourceMappingURL=getScimToken.d.ts.map