1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Identity
  5. getSmtpCredentials
Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi

oci.Identity.getSmtpCredentials

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi

    This data source provides the list of Smtp Credentials in Oracle Cloud Infrastructure Identity service.

    Lists the SMTP credentials for the specified user. The returned object contains the credential’s OCID, the SMTP user name but not the SMTP password. The SMTP password is returned only upon creation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testSmtpCredentials = oci.Identity.getSmtpCredentials({
        userId: testUser.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_smtp_credentials = oci.Identity.get_smtp_credentials(user_id=test_user["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Identity"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Identity.GetSmtpCredentials(ctx, &identity.GetSmtpCredentialsArgs{
    			UserId: testUser.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testSmtpCredentials = Oci.Identity.GetSmtpCredentials.Invoke(new()
        {
            UserId = testUser.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Identity.IdentityFunctions;
    import com.pulumi.oci.Identity.inputs.GetSmtpCredentialsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var testSmtpCredentials = IdentityFunctions.getSmtpCredentials(GetSmtpCredentialsArgs.builder()
                .userId(testUser.id())
                .build());
    
        }
    }
    
    variables:
      testSmtpCredentials:
        fn::invoke:
          Function: oci:Identity:getSmtpCredentials
          Arguments:
            userId: ${testUser.id}
    

    Using getSmtpCredentials

    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 getSmtpCredentials(args: GetSmtpCredentialsArgs, opts?: InvokeOptions): Promise<GetSmtpCredentialsResult>
    function getSmtpCredentialsOutput(args: GetSmtpCredentialsOutputArgs, opts?: InvokeOptions): Output<GetSmtpCredentialsResult>
    def get_smtp_credentials(filters: Optional[Sequence[_identity.GetSmtpCredentialsFilter]] = None,
                             user_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetSmtpCredentialsResult
    def get_smtp_credentials_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[_identity.GetSmtpCredentialsFilterArgs]]]] = None,
                             user_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetSmtpCredentialsResult]
    func GetSmtpCredentials(ctx *Context, args *GetSmtpCredentialsArgs, opts ...InvokeOption) (*GetSmtpCredentialsResult, error)
    func GetSmtpCredentialsOutput(ctx *Context, args *GetSmtpCredentialsOutputArgs, opts ...InvokeOption) GetSmtpCredentialsResultOutput

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

    public static class GetSmtpCredentials 
    {
        public static Task<GetSmtpCredentialsResult> InvokeAsync(GetSmtpCredentialsArgs args, InvokeOptions? opts = null)
        public static Output<GetSmtpCredentialsResult> Invoke(GetSmtpCredentialsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSmtpCredentialsResult> getSmtpCredentials(GetSmtpCredentialsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Identity/getSmtpCredentials:getSmtpCredentials
      arguments:
        # arguments dictionary

    The following arguments are supported:

    UserId string
    The OCID of the user.
    Filters List<GetSmtpCredentialsFilter>
    UserId string
    The OCID of the user.
    Filters []GetSmtpCredentialsFilter
    userId String
    The OCID of the user.
    filters List<GetSmtpCredentialsFilter>
    userId string
    The OCID of the user.
    filters GetSmtpCredentialsFilter[]
    userId String
    The OCID of the user.
    filters List<Property Map>

    getSmtpCredentials Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    SmtpCredentials List<GetSmtpCredentialsSmtpCredential>
    The list of smtp_credentials.
    UserId string
    The OCID of the user the SMTP credential belongs to.
    Filters List<GetSmtpCredentialsFilter>
    Id string
    The provider-assigned unique ID for this managed resource.
    SmtpCredentials []GetSmtpCredentialsSmtpCredential
    The list of smtp_credentials.
    UserId string
    The OCID of the user the SMTP credential belongs to.
    Filters []GetSmtpCredentialsFilter
    id String
    The provider-assigned unique ID for this managed resource.
    smtpCredentials List<GetSmtpCredentialsSmtpCredential>
    The list of smtp_credentials.
    userId String
    The OCID of the user the SMTP credential belongs to.
    filters List<GetSmtpCredentialsFilter>
    id string
    The provider-assigned unique ID for this managed resource.
    smtpCredentials GetSmtpCredentialsSmtpCredential[]
    The list of smtp_credentials.
    userId string
    The OCID of the user the SMTP credential belongs to.
    filters GetSmtpCredentialsFilter[]
    id str
    The provider-assigned unique ID for this managed resource.
    smtp_credentials Sequence[identity.GetSmtpCredentialsSmtpCredential]
    The list of smtp_credentials.
    user_id str
    The OCID of the user the SMTP credential belongs to.
    filters Sequence[identity.GetSmtpCredentialsFilter]
    id String
    The provider-assigned unique ID for this managed resource.
    smtpCredentials List<Property Map>
    The list of smtp_credentials.
    userId String
    The OCID of the user the SMTP credential belongs to.
    filters List<Property Map>

    Supporting Types

    GetSmtpCredentialsFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetSmtpCredentialsSmtpCredential

    Description string
    The description you assign to the SMTP credential. Does not have to be unique, and it's changeable.
    Id string
    The OCID of the SMTP credential.
    InactiveState string
    The detailed status of INACTIVE lifecycleState.
    Password string
    State string
    The credential's current state.
    TimeCreated string
    Date and time the SmtpCredential object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeExpires string
    Date and time when this credential will expire, in the format defined by RFC3339. Null if it never expires. Example: 2016-08-25T21:10:29.600Z
    UserId string
    The OCID of the user.
    Username string
    The SMTP user name.
    Description string
    The description you assign to the SMTP credential. Does not have to be unique, and it's changeable.
    Id string
    The OCID of the SMTP credential.
    InactiveState string
    The detailed status of INACTIVE lifecycleState.
    Password string
    State string
    The credential's current state.
    TimeCreated string
    Date and time the SmtpCredential object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeExpires string
    Date and time when this credential will expire, in the format defined by RFC3339. Null if it never expires. Example: 2016-08-25T21:10:29.600Z
    UserId string
    The OCID of the user.
    Username string
    The SMTP user name.
    description String
    The description you assign to the SMTP credential. Does not have to be unique, and it's changeable.
    id String
    The OCID of the SMTP credential.
    inactiveState String
    The detailed status of INACTIVE lifecycleState.
    password String
    state String
    The credential's current state.
    timeCreated String
    Date and time the SmtpCredential object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeExpires String
    Date and time when this credential will expire, in the format defined by RFC3339. Null if it never expires. Example: 2016-08-25T21:10:29.600Z
    userId String
    The OCID of the user.
    username String
    The SMTP user name.
    description string
    The description you assign to the SMTP credential. Does not have to be unique, and it's changeable.
    id string
    The OCID of the SMTP credential.
    inactiveState string
    The detailed status of INACTIVE lifecycleState.
    password string
    state string
    The credential's current state.
    timeCreated string
    Date and time the SmtpCredential object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeExpires string
    Date and time when this credential will expire, in the format defined by RFC3339. Null if it never expires. Example: 2016-08-25T21:10:29.600Z
    userId string
    The OCID of the user.
    username string
    The SMTP user name.
    description str
    The description you assign to the SMTP credential. Does not have to be unique, and it's changeable.
    id str
    The OCID of the SMTP credential.
    inactive_state str
    The detailed status of INACTIVE lifecycleState.
    password str
    state str
    The credential's current state.
    time_created str
    Date and time the SmtpCredential object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    time_expires str
    Date and time when this credential will expire, in the format defined by RFC3339. Null if it never expires. Example: 2016-08-25T21:10:29.600Z
    user_id str
    The OCID of the user.
    username str
    The SMTP user name.
    description String
    The description you assign to the SMTP credential. Does not have to be unique, and it's changeable.
    id String
    The OCID of the SMTP credential.
    inactiveState String
    The detailed status of INACTIVE lifecycleState.
    password String
    state String
    The credential's current state.
    timeCreated String
    Date and time the SmtpCredential object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeExpires String
    Date and time when this credential will expire, in the format defined by RFC3339. Null if it never expires. Example: 2016-08-25T21:10:29.600Z
    userId String
    The OCID of the user.
    username String
    The SMTP user name.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi