1. Packages
  2. Linode Provider
  3. API Docs
  4. getProfile
Linode v4.30.0 published on Friday, Nov 8, 2024 by Pulumi

linode.getProfile

Explore with Pulumi AI

linode logo
Linode v4.30.0 published on Friday, Nov 8, 2024 by Pulumi

    Provides information about a Linode profile. For more information, see the Linode APIv4 docs.

    Example Usage

    The following example shows how one might use this data source to access profile details.

    import * as pulumi from "@pulumi/pulumi";
    import * as linode from "@pulumi/linode";
    
    const profile = linode.getProfile({});
    
    import pulumi
    import pulumi_linode as linode
    
    profile = linode.get_profile()
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := linode.GetProfile(ctx, map[string]interface{}{}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Linode = Pulumi.Linode;
    
    return await Deployment.RunAsync(() => 
    {
        var profile = Linode.GetProfile.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.linode.LinodeFunctions;
    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 profile = LinodeFunctions.getProfile();
    
        }
    }
    
    variables:
      profile:
        fn::invoke:
          Function: linode:getProfile
          Arguments: {}
    

    Using getProfile

    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 getProfile(opts?: InvokeOptions): Promise<GetProfileResult>
    function getProfileOutput(opts?: InvokeOptions): Output<GetProfileResult>
    def get_profile(opts: Optional[InvokeOptions] = None) -> GetProfileResult
    def get_profile_output(opts: Optional[InvokeOptions] = None) -> Output[GetProfileResult]
    func GetProfile(ctx *Context, opts ...InvokeOption) (*GetProfileResult, error)
    func GetProfileOutput(ctx *Context, opts ...InvokeOption) GetProfileResultOutput

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

    public static class GetProfile 
    {
        public static Task<GetProfileResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetProfileResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetProfileResult> getProfile(InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: linode:index/getProfile:getProfile
      arguments:
        # arguments dictionary

    getProfile Result

    The following output properties are available:

    AuthorizedKeys List<string>
    The list of SSH Keys authorized to use Lish for this user. This value is ignored if lish_auth_method is 'disabled'.
    Email string
    The profile email address. This address will be used for communication with Linode as necessary.
    EmailNotifications bool
    If true, email notifications will be sent about account activity. If false, when false business-critical communications may still be sent through email.
    Id string
    IpWhitelistEnabled bool
    If true, logins for the user will only be allowed from whitelisted IPs. This setting is currently deprecated, and cannot be enabled.
    LishAuthMethod string
    The methods of authentication allowed when connecting via Lish. 'keys_only' is the most secure with the intent to use Lish, and 'disabled' is recommended for users that will not use Lish at all.
    Referrals GetProfileReferrals
    Credit Card information associated with this Account.
    Restricted bool
    If true, the user has restrictions on what can be accessed on the Account.
    Timezone string
    The profile's preferred timezone. This is not used by the API, and is for the benefit of clients only. All times the API returns are in UTC.
    TwoFactorAuth bool
    If true, logins from untrusted computers will require Two Factor Authentication.
    Username string
    The username for logging in to Linode services.
    AuthorizedKeys []string
    The list of SSH Keys authorized to use Lish for this user. This value is ignored if lish_auth_method is 'disabled'.
    Email string
    The profile email address. This address will be used for communication with Linode as necessary.
    EmailNotifications bool
    If true, email notifications will be sent about account activity. If false, when false business-critical communications may still be sent through email.
    Id string
    IpWhitelistEnabled bool
    If true, logins for the user will only be allowed from whitelisted IPs. This setting is currently deprecated, and cannot be enabled.
    LishAuthMethod string
    The methods of authentication allowed when connecting via Lish. 'keys_only' is the most secure with the intent to use Lish, and 'disabled' is recommended for users that will not use Lish at all.
    Referrals GetProfileReferrals
    Credit Card information associated with this Account.
    Restricted bool
    If true, the user has restrictions on what can be accessed on the Account.
    Timezone string
    The profile's preferred timezone. This is not used by the API, and is for the benefit of clients only. All times the API returns are in UTC.
    TwoFactorAuth bool
    If true, logins from untrusted computers will require Two Factor Authentication.
    Username string
    The username for logging in to Linode services.
    authorizedKeys List<String>
    The list of SSH Keys authorized to use Lish for this user. This value is ignored if lish_auth_method is 'disabled'.
    email String
    The profile email address. This address will be used for communication with Linode as necessary.
    emailNotifications Boolean
    If true, email notifications will be sent about account activity. If false, when false business-critical communications may still be sent through email.
    id String
    ipWhitelistEnabled Boolean
    If true, logins for the user will only be allowed from whitelisted IPs. This setting is currently deprecated, and cannot be enabled.
    lishAuthMethod String
    The methods of authentication allowed when connecting via Lish. 'keys_only' is the most secure with the intent to use Lish, and 'disabled' is recommended for users that will not use Lish at all.
    referrals GetProfileReferrals
    Credit Card information associated with this Account.
    restricted Boolean
    If true, the user has restrictions on what can be accessed on the Account.
    timezone String
    The profile's preferred timezone. This is not used by the API, and is for the benefit of clients only. All times the API returns are in UTC.
    twoFactorAuth Boolean
    If true, logins from untrusted computers will require Two Factor Authentication.
    username String
    The username for logging in to Linode services.
    authorizedKeys string[]
    The list of SSH Keys authorized to use Lish for this user. This value is ignored if lish_auth_method is 'disabled'.
    email string
    The profile email address. This address will be used for communication with Linode as necessary.
    emailNotifications boolean
    If true, email notifications will be sent about account activity. If false, when false business-critical communications may still be sent through email.
    id string
    ipWhitelistEnabled boolean
    If true, logins for the user will only be allowed from whitelisted IPs. This setting is currently deprecated, and cannot be enabled.
    lishAuthMethod string
    The methods of authentication allowed when connecting via Lish. 'keys_only' is the most secure with the intent to use Lish, and 'disabled' is recommended for users that will not use Lish at all.
    referrals GetProfileReferrals
    Credit Card information associated with this Account.
    restricted boolean
    If true, the user has restrictions on what can be accessed on the Account.
    timezone string
    The profile's preferred timezone. This is not used by the API, and is for the benefit of clients only. All times the API returns are in UTC.
    twoFactorAuth boolean
    If true, logins from untrusted computers will require Two Factor Authentication.
    username string
    The username for logging in to Linode services.
    authorized_keys Sequence[str]
    The list of SSH Keys authorized to use Lish for this user. This value is ignored if lish_auth_method is 'disabled'.
    email str
    The profile email address. This address will be used for communication with Linode as necessary.
    email_notifications bool
    If true, email notifications will be sent about account activity. If false, when false business-critical communications may still be sent through email.
    id str
    ip_whitelist_enabled bool
    If true, logins for the user will only be allowed from whitelisted IPs. This setting is currently deprecated, and cannot be enabled.
    lish_auth_method str
    The methods of authentication allowed when connecting via Lish. 'keys_only' is the most secure with the intent to use Lish, and 'disabled' is recommended for users that will not use Lish at all.
    referrals GetProfileReferrals
    Credit Card information associated with this Account.
    restricted bool
    If true, the user has restrictions on what can be accessed on the Account.
    timezone str
    The profile's preferred timezone. This is not used by the API, and is for the benefit of clients only. All times the API returns are in UTC.
    two_factor_auth bool
    If true, logins from untrusted computers will require Two Factor Authentication.
    username str
    The username for logging in to Linode services.
    authorizedKeys List<String>
    The list of SSH Keys authorized to use Lish for this user. This value is ignored if lish_auth_method is 'disabled'.
    email String
    The profile email address. This address will be used for communication with Linode as necessary.
    emailNotifications Boolean
    If true, email notifications will be sent about account activity. If false, when false business-critical communications may still be sent through email.
    id String
    ipWhitelistEnabled Boolean
    If true, logins for the user will only be allowed from whitelisted IPs. This setting is currently deprecated, and cannot be enabled.
    lishAuthMethod String
    The methods of authentication allowed when connecting via Lish. 'keys_only' is the most secure with the intent to use Lish, and 'disabled' is recommended for users that will not use Lish at all.
    referrals Property Map
    Credit Card information associated with this Account.
    restricted Boolean
    If true, the user has restrictions on what can be accessed on the Account.
    timezone String
    The profile's preferred timezone. This is not used by the API, and is for the benefit of clients only. All times the API returns are in UTC.
    twoFactorAuth Boolean
    If true, logins from untrusted computers will require Two Factor Authentication.
    username String
    The username for logging in to Linode services.

    Supporting Types

    GetProfileReferrals

    Code string
    The Profile referral code. If new accounts use this when signing up for Linode, referring account will receive credit.
    Completed int
    The number of completed signups with the referral code.
    Credit double
    The amount of account credit in US Dollars issued to the account through the referral program.
    Pending int
    The number of pending signups for the referral code. To receive credit the signups must be completed.
    Total int
    The number of users who have signed up with the referral code.
    Url string
    The referral URL.
    Code string
    The Profile referral code. If new accounts use this when signing up for Linode, referring account will receive credit.
    Completed int
    The number of completed signups with the referral code.
    Credit float64
    The amount of account credit in US Dollars issued to the account through the referral program.
    Pending int
    The number of pending signups for the referral code. To receive credit the signups must be completed.
    Total int
    The number of users who have signed up with the referral code.
    Url string
    The referral URL.
    code String
    The Profile referral code. If new accounts use this when signing up for Linode, referring account will receive credit.
    completed Integer
    The number of completed signups with the referral code.
    credit Double
    The amount of account credit in US Dollars issued to the account through the referral program.
    pending Integer
    The number of pending signups for the referral code. To receive credit the signups must be completed.
    total Integer
    The number of users who have signed up with the referral code.
    url String
    The referral URL.
    code string
    The Profile referral code. If new accounts use this when signing up for Linode, referring account will receive credit.
    completed number
    The number of completed signups with the referral code.
    credit number
    The amount of account credit in US Dollars issued to the account through the referral program.
    pending number
    The number of pending signups for the referral code. To receive credit the signups must be completed.
    total number
    The number of users who have signed up with the referral code.
    url string
    The referral URL.
    code str
    The Profile referral code. If new accounts use this when signing up for Linode, referring account will receive credit.
    completed int
    The number of completed signups with the referral code.
    credit float
    The amount of account credit in US Dollars issued to the account through the referral program.
    pending int
    The number of pending signups for the referral code. To receive credit the signups must be completed.
    total int
    The number of users who have signed up with the referral code.
    url str
    The referral URL.
    code String
    The Profile referral code. If new accounts use this when signing up for Linode, referring account will receive credit.
    completed Number
    The number of completed signups with the referral code.
    credit Number
    The amount of account credit in US Dollars issued to the account through the referral program.
    pending Number
    The number of pending signups for the referral code. To receive credit the signups must be completed.
    total Number
    The number of users who have signed up with the referral code.
    url String
    The referral URL.

    Package Details

    Repository
    Linode pulumi/pulumi-linode
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the linode Terraform Provider.
    linode logo
    Linode v4.30.0 published on Friday, Nov 8, 2024 by Pulumi