@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
258 lines (257 loc) • 7.52 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage iam oauth provider
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const foo = new volcengine.iam.OauthProvider("foo", {
* authorizeTemplate: "${authEndpoint}?client_id=${clientId}&scope=${scope}&response_type=code&state=12345",
* authorizeUrl: "https://example.com/authorize",
* clientId: "test_client_id",
* clientSecret: "",
* description: "acc-test",
* identityMapType: 1,
* idpIdentityKey: "username",
* oauthProviderName: "acc-test-oauth",
* scope: "openid",
* ssoType: 2,
* status: 1,
* tokenUrl: "https://example.com/access_token",
* userInfoUrl: "https://example.com/user_info",
* });
* ```
*
* ## Import
*
* IamOAuthProvider can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:iam/oauthProvider:OauthProvider default oidc_provider_name
* ```
*/
export declare class OauthProvider extends pulumi.CustomResource {
/**
* Get an existing OauthProvider 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?: OauthProviderState, opts?: pulumi.CustomResourceOptions): OauthProvider;
/**
* Returns true if the given object is an instance of OauthProvider. 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 OauthProvider;
/**
* The authorize template of the OAuth provider.
*/
readonly authorizeTemplate: pulumi.Output<string>;
/**
* The authorize url of the OAuth provider.
*/
readonly authorizeUrl: pulumi.Output<string>;
/**
* The client id of the OAuth provider.
*/
readonly clientId: pulumi.Output<string>;
/**
* The client secret of the OAuth provider.
*/
readonly clientSecret: pulumi.Output<string>;
/**
* The create date of the OAuth provider.
*/
readonly createDate: pulumi.Output<string>;
/**
* The description of the OAuth provider.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The identity map type of the OAuth provider.
*/
readonly identityMapType: pulumi.Output<number>;
/**
* The idp identity key of the OAuth provider.
*/
readonly idpIdentityKey: pulumi.Output<string>;
/**
* The name of the OAuth provider.
*/
readonly oauthProviderName: pulumi.Output<string>;
/**
* The id of the OAuth provider.
*/
readonly providerId: pulumi.Output<string>;
/**
* The scope of the OAuth provider.
*/
readonly scope: pulumi.Output<string | undefined>;
/**
* The SSO type of the OAuth provider.
*/
readonly ssoType: pulumi.Output<number>;
/**
* The status of the OAuth provider.
*/
readonly status: pulumi.Output<number | undefined>;
/**
* The token url of the OAuth provider.
*/
readonly tokenUrl: pulumi.Output<string>;
/**
* The trn of the OAuth provider.
*/
readonly trn: pulumi.Output<string>;
/**
* The update date of the OAuth provider.
*/
readonly updateDate: pulumi.Output<string>;
/**
* The user info url of the OAuth provider.
*/
readonly userInfoUrl: pulumi.Output<string>;
/**
* Create a OauthProvider 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: OauthProviderArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering OauthProvider resources.
*/
export interface OauthProviderState {
/**
* The authorize template of the OAuth provider.
*/
authorizeTemplate?: pulumi.Input<string>;
/**
* The authorize url of the OAuth provider.
*/
authorizeUrl?: pulumi.Input<string>;
/**
* The client id of the OAuth provider.
*/
clientId?: pulumi.Input<string>;
/**
* The client secret of the OAuth provider.
*/
clientSecret?: pulumi.Input<string>;
/**
* The create date of the OAuth provider.
*/
createDate?: pulumi.Input<string>;
/**
* The description of the OAuth provider.
*/
description?: pulumi.Input<string>;
/**
* The identity map type of the OAuth provider.
*/
identityMapType?: pulumi.Input<number>;
/**
* The idp identity key of the OAuth provider.
*/
idpIdentityKey?: pulumi.Input<string>;
/**
* The name of the OAuth provider.
*/
oauthProviderName?: pulumi.Input<string>;
/**
* The id of the OAuth provider.
*/
providerId?: pulumi.Input<string>;
/**
* The scope of the OAuth provider.
*/
scope?: pulumi.Input<string>;
/**
* The SSO type of the OAuth provider.
*/
ssoType?: pulumi.Input<number>;
/**
* The status of the OAuth provider.
*/
status?: pulumi.Input<number>;
/**
* The token url of the OAuth provider.
*/
tokenUrl?: pulumi.Input<string>;
/**
* The trn of the OAuth provider.
*/
trn?: pulumi.Input<string>;
/**
* The update date of the OAuth provider.
*/
updateDate?: pulumi.Input<string>;
/**
* The user info url of the OAuth provider.
*/
userInfoUrl?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a OauthProvider resource.
*/
export interface OauthProviderArgs {
/**
* The authorize template of the OAuth provider.
*/
authorizeTemplate: pulumi.Input<string>;
/**
* The authorize url of the OAuth provider.
*/
authorizeUrl: pulumi.Input<string>;
/**
* The client id of the OAuth provider.
*/
clientId: pulumi.Input<string>;
/**
* The client secret of the OAuth provider.
*/
clientSecret: pulumi.Input<string>;
/**
* The description of the OAuth provider.
*/
description?: pulumi.Input<string>;
/**
* The identity map type of the OAuth provider.
*/
identityMapType: pulumi.Input<number>;
/**
* The idp identity key of the OAuth provider.
*/
idpIdentityKey: pulumi.Input<string>;
/**
* The name of the OAuth provider.
*/
oauthProviderName: pulumi.Input<string>;
/**
* The scope of the OAuth provider.
*/
scope?: pulumi.Input<string>;
/**
* The SSO type of the OAuth provider.
*/
ssoType: pulumi.Input<number>;
/**
* The status of the OAuth provider.
*/
status?: pulumi.Input<number>;
/**
* The token url of the OAuth provider.
*/
tokenUrl: pulumi.Input<string>;
/**
* The user info url of the OAuth provider.
*/
userInfoUrl: pulumi.Input<string>;
}