1. Packages
  2. NS1
  3. API Docs
  4. User
NS1 v3.1.5 published on Friday, Jan 19, 2024 by Pulumi

ns1.User

Explore with Pulumi AI

ns1 logo
NS1 v3.1.5 published on Friday, Jan 19, 2024 by Pulumi

    Provides a NS1 User resource. Creating a user sends an invitation email to the user’s email address. This can be used to create, modify, and delete users. The credentials used must have the manage_users permission set.

    Permissions

    A user will inherit permissions from the teams they are assigned to. If a user is assigned to a team and also has individual permissions set on the user, the individual permissions will be overridden by the inherited team permissions. In a future release, setting permissions on a user that is part of a team will be explicitly disabled.

    When a user is removed from all teams completely, they will inherit whatever permissions they had previously. If a user is removed from all their teams, it will probably be necessary to run pulumi up a second time to update the users permissions from their old team permissions to new user-specific permissions.

    See this NS1 Help Center article for an overview of user permission settings.

    NS1 Documentation

    User Api Docs

    Managing user permissions

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ns1 = Pulumi.Ns1;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleTeam = new Ns1.Team("exampleTeam", new()
        {
            IpWhitelists = new[]
            {
                "1.1.1.1",
                "2.2.2.2",
            },
            DnsViewZones = false,
            AccountManageUsers = false,
        });
    
        var exampleUser = new Ns1.User("exampleUser", new()
        {
            Username = "example_user",
            Email = "user@example.com",
            Teams = new[]
            {
                exampleTeam.Id,
            },
            Notify = 
            {
                { "billing", false },
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-ns1/sdk/v3/go/ns1"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleTeam, err := ns1.NewTeam(ctx, "exampleTeam", &ns1.TeamArgs{
    			IpWhitelists: ns1.TeamIpWhitelistArray{
    				"1.1.1.1",
    				"2.2.2.2",
    			},
    			DnsViewZones:       pulumi.Bool(false),
    			AccountManageUsers: pulumi.Bool(false),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ns1.NewUser(ctx, "exampleUser", &ns1.UserArgs{
    			Username: pulumi.String("example_user"),
    			Email:    pulumi.String("user@example.com"),
    			Teams: pulumi.StringArray{
    				exampleTeam.ID(),
    			},
    			Notify: pulumi.Map{
    				"billing": pulumi.Any(false),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ns1.Team;
    import com.pulumi.ns1.TeamArgs;
    import com.pulumi.ns1.User;
    import com.pulumi.ns1.UserArgs;
    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) {
            var exampleTeam = new Team("exampleTeam", TeamArgs.builder()        
                .ipWhitelists(            
                    "1.1.1.1",
                    "2.2.2.2")
                .dnsViewZones(false)
                .accountManageUsers(false)
                .build());
    
            var exampleUser = new User("exampleUser", UserArgs.builder()        
                .username("example_user")
                .email("user@example.com")
                .teams(exampleTeam.id())
                .notify(Map.of("billing", false))
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_ns1 as ns1
    
    example_team = ns1.Team("exampleTeam",
        ip_whitelists=[
            "1.1.1.1",
            "2.2.2.2",
        ],
        dns_view_zones=False,
        account_manage_users=False)
    example_user = ns1.User("exampleUser",
        username="example_user",
        email="user@example.com",
        teams=[example_team.id],
        notify={
            "billing": False,
        })
    
    import * as pulumi from "@pulumi/pulumi";
    import * as ns1 from "@pulumi/ns1";
    
    const exampleTeam = new ns1.Team("exampleTeam", {
        ipWhitelists: [
            "1.1.1.1",
            "2.2.2.2",
        ],
        dnsViewZones: false,
        accountManageUsers: false,
    });
    const exampleUser = new ns1.User("exampleUser", {
        username: "example_user",
        email: "user@example.com",
        teams: [exampleTeam.id],
        notify: {
            billing: false,
        },
    });
    
    resources:
      exampleTeam:
        type: ns1:Team
        properties:
          # Optional IP whitelist
          ipWhitelists:
            - 1.1.1.1
            - 2.2.2.2
          dnsViewZones: false
          accountManageUsers: false
      exampleUser:
        type: ns1:User
        properties:
          username: example_user
          email: user@example.com
          teams:
            - ${exampleTeam.id}
          notify:
            billing: false
    

    Create User Resource

    new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
    @overload
    def User(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             account_manage_account_settings: Optional[bool] = None,
             account_manage_apikeys: Optional[bool] = None,
             account_manage_ip_whitelist: Optional[bool] = None,
             account_manage_payment_methods: Optional[bool] = None,
             account_manage_plan: Optional[bool] = None,
             account_manage_teams: Optional[bool] = None,
             account_manage_users: Optional[bool] = None,
             account_view_activity_log: Optional[bool] = None,
             account_view_invoices: Optional[bool] = None,
             data_manage_datafeeds: Optional[bool] = None,
             data_manage_datasources: Optional[bool] = None,
             data_push_to_datafeeds: Optional[bool] = None,
             dhcp_manage_dhcp: Optional[bool] = None,
             dhcp_view_dhcp: Optional[bool] = None,
             dns_manage_zones: Optional[bool] = None,
             dns_records_allows: Optional[Sequence[UserDnsRecordsAllowArgs]] = None,
             dns_records_denies: Optional[Sequence[UserDnsRecordsDenyArgs]] = None,
             dns_view_zones: Optional[bool] = None,
             dns_zones_allow_by_default: Optional[bool] = None,
             dns_zones_allows: Optional[Sequence[str]] = None,
             dns_zones_denies: Optional[Sequence[str]] = None,
             email: Optional[str] = None,
             ip_whitelist_strict: Optional[bool] = None,
             ip_whitelists: Optional[Sequence[str]] = None,
             ipam_manage_ipam: Optional[bool] = None,
             ipam_view_ipam: Optional[bool] = None,
             monitoring_manage_jobs: Optional[bool] = None,
             monitoring_manage_lists: Optional[bool] = None,
             monitoring_view_jobs: Optional[bool] = None,
             name: Optional[str] = None,
             notify: Optional[Mapping[str, Any]] = None,
             security_manage_active_directory: Optional[bool] = None,
             security_manage_global2fa: Optional[bool] = None,
             teams: Optional[Sequence[str]] = None,
             username: Optional[str] = None)
    @overload
    def User(resource_name: str,
             args: UserArgs,
             opts: Optional[ResourceOptions] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
    public User(String name, UserArgs args, CustomResourceOptions options)
    
    type: ns1:User
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    User Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The User resource accepts the following input properties:

    Email string
    The email address of the user.
    Username string
    The users login name.
    AccountManageAccountSettings bool
    Whether the user can modify account settings.
    AccountManageApikeys bool
    Whether the user can modify account apikeys.
    AccountManageIpWhitelist bool
    Whether the user can manage ip whitelist.
    AccountManagePaymentMethods bool
    Whether the user can modify account payment methods.
    AccountManagePlan bool
    No longer in use.

    Deprecated:obsolete, should no longer be used

    AccountManageTeams bool
    Whether the user can modify other teams in the account.
    AccountManageUsers bool
    Whether the user can modify account users.
    AccountViewActivityLog bool
    Whether the user can view activity logs.
    AccountViewInvoices bool
    Whether the user can view invoices.
    DataManageDatafeeds bool
    Whether the user can modify data feeds.
    DataManageDatasources bool
    Whether the user can modify data sources.
    DataPushToDatafeeds bool
    Whether the user can publish to data feeds.
    DhcpManageDhcp bool
    Whether the user can manage DHCP. Only relevant for the DDI product.
    DhcpViewDhcp bool
    Whether the user can view DHCP. Only relevant for the DDI product.
    DnsManageZones bool
    Whether the user can modify the accounts zones.
    DnsRecordsAllows List<UserDnsRecordsAllow>
    DnsRecordsDenies List<UserDnsRecordsDeny>
    DnsViewZones bool
    Whether the user can view the accounts zones.
    DnsZonesAllowByDefault bool
    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
    DnsZonesAllows List<string>
    List of zones that the user may access.
    DnsZonesDenies List<string>
    List of zones that the user may not access.
    IpWhitelistStrict bool
    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.
    IpWhitelists List<string>
    Array of IP addresses/networks to which to grant the user access.
    IpamManageIpam bool
    Whether the user can manage IPAM. Only relevant for the DDI product.
    IpamViewIpam bool
    MonitoringManageJobs bool
    Whether the user can modify monitoring jobs.
    MonitoringManageLists bool
    Whether the user can modify notification lists.
    MonitoringViewJobs bool
    Whether the user can view monitoring jobs.
    Name string
    The free form name of the user.
    Notify Dictionary<string, object>
    Whether or not to notify the user of specified events. Only billing is available currently.
    SecurityManageActiveDirectory bool
    Whether the user can manage global active directory. Only relevant for the DDI product.
    SecurityManageGlobal2fa bool
    Whether the user can manage global two factor authentication.
    Teams List<string>
    The teams that the user belongs to.
    Email string
    The email address of the user.
    Username string
    The users login name.
    AccountManageAccountSettings bool
    Whether the user can modify account settings.
    AccountManageApikeys bool
    Whether the user can modify account apikeys.
    AccountManageIpWhitelist bool
    Whether the user can manage ip whitelist.
    AccountManagePaymentMethods bool
    Whether the user can modify account payment methods.
    AccountManagePlan bool
    No longer in use.

    Deprecated:obsolete, should no longer be used

    AccountManageTeams bool
    Whether the user can modify other teams in the account.
    AccountManageUsers bool
    Whether the user can modify account users.
    AccountViewActivityLog bool
    Whether the user can view activity logs.
    AccountViewInvoices bool
    Whether the user can view invoices.
    DataManageDatafeeds bool
    Whether the user can modify data feeds.
    DataManageDatasources bool
    Whether the user can modify data sources.
    DataPushToDatafeeds bool
    Whether the user can publish to data feeds.
    DhcpManageDhcp bool
    Whether the user can manage DHCP. Only relevant for the DDI product.
    DhcpViewDhcp bool
    Whether the user can view DHCP. Only relevant for the DDI product.
    DnsManageZones bool
    Whether the user can modify the accounts zones.
    DnsRecordsAllows []UserDnsRecordsAllowArgs
    DnsRecordsDenies []UserDnsRecordsDenyArgs
    DnsViewZones bool
    Whether the user can view the accounts zones.
    DnsZonesAllowByDefault bool
    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
    DnsZonesAllows []string
    List of zones that the user may access.
    DnsZonesDenies []string
    List of zones that the user may not access.
    IpWhitelistStrict bool
    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.
    IpWhitelists []string
    Array of IP addresses/networks to which to grant the user access.
    IpamManageIpam bool
    Whether the user can manage IPAM. Only relevant for the DDI product.
    IpamViewIpam bool
    MonitoringManageJobs bool
    Whether the user can modify monitoring jobs.
    MonitoringManageLists bool
    Whether the user can modify notification lists.
    MonitoringViewJobs bool
    Whether the user can view monitoring jobs.
    Name string
    The free form name of the user.
    Notify map[string]interface{}
    Whether or not to notify the user of specified events. Only billing is available currently.
    SecurityManageActiveDirectory bool
    Whether the user can manage global active directory. Only relevant for the DDI product.
    SecurityManageGlobal2fa bool
    Whether the user can manage global two factor authentication.
    Teams []string
    The teams that the user belongs to.
    email String
    The email address of the user.
    username String
    The users login name.
    accountManageAccountSettings Boolean
    Whether the user can modify account settings.
    accountManageApikeys Boolean
    Whether the user can modify account apikeys.
    accountManageIpWhitelist Boolean
    Whether the user can manage ip whitelist.
    accountManagePaymentMethods Boolean
    Whether the user can modify account payment methods.
    accountManagePlan Boolean
    No longer in use.

    Deprecated:obsolete, should no longer be used

    accountManageTeams Boolean
    Whether the user can modify other teams in the account.
    accountManageUsers Boolean
    Whether the user can modify account users.
    accountViewActivityLog Boolean
    Whether the user can view activity logs.
    accountViewInvoices Boolean
    Whether the user can view invoices.
    dataManageDatafeeds Boolean
    Whether the user can modify data feeds.
    dataManageDatasources Boolean
    Whether the user can modify data sources.
    dataPushToDatafeeds Boolean
    Whether the user can publish to data feeds.
    dhcpManageDhcp Boolean
    Whether the user can manage DHCP. Only relevant for the DDI product.
    dhcpViewDhcp Boolean
    Whether the user can view DHCP. Only relevant for the DDI product.
    dnsManageZones Boolean
    Whether the user can modify the accounts zones.
    dnsRecordsAllows List<UserDnsRecordsAllow>
    dnsRecordsDenies List<UserDnsRecordsDeny>
    dnsViewZones Boolean
    Whether the user can view the accounts zones.
    dnsZonesAllowByDefault Boolean
    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
    dnsZonesAllows List<String>
    List of zones that the user may access.
    dnsZonesDenies List<String>
    List of zones that the user may not access.
    ipWhitelistStrict Boolean
    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.
    ipWhitelists List<String>
    Array of IP addresses/networks to which to grant the user access.
    ipamManageIpam Boolean
    Whether the user can manage IPAM. Only relevant for the DDI product.
    ipamViewIpam Boolean
    monitoringManageJobs Boolean
    Whether the user can modify monitoring jobs.
    monitoringManageLists Boolean
    Whether the user can modify notification lists.
    monitoringViewJobs Boolean
    Whether the user can view monitoring jobs.
    name String
    The free form name of the user.
    notify_ Map<String,Object>
    Whether or not to notify the user of specified events. Only billing is available currently.
    securityManageActiveDirectory Boolean
    Whether the user can manage global active directory. Only relevant for the DDI product.
    securityManageGlobal2fa Boolean
    Whether the user can manage global two factor authentication.
    teams List<String>
    The teams that the user belongs to.
    email string
    The email address of the user.
    username string
    The users login name.
    accountManageAccountSettings boolean
    Whether the user can modify account settings.
    accountManageApikeys boolean
    Whether the user can modify account apikeys.
    accountManageIpWhitelist boolean
    Whether the user can manage ip whitelist.
    accountManagePaymentMethods boolean
    Whether the user can modify account payment methods.
    accountManagePlan boolean
    No longer in use.

    Deprecated:obsolete, should no longer be used

    accountManageTeams boolean
    Whether the user can modify other teams in the account.
    accountManageUsers boolean
    Whether the user can modify account users.
    accountViewActivityLog boolean
    Whether the user can view activity logs.
    accountViewInvoices boolean
    Whether the user can view invoices.
    dataManageDatafeeds boolean
    Whether the user can modify data feeds.
    dataManageDatasources boolean
    Whether the user can modify data sources.
    dataPushToDatafeeds boolean
    Whether the user can publish to data feeds.
    dhcpManageDhcp boolean
    Whether the user can manage DHCP. Only relevant for the DDI product.
    dhcpViewDhcp boolean
    Whether the user can view DHCP. Only relevant for the DDI product.
    dnsManageZones boolean
    Whether the user can modify the accounts zones.
    dnsRecordsAllows UserDnsRecordsAllow[]
    dnsRecordsDenies UserDnsRecordsDeny[]
    dnsViewZones boolean
    Whether the user can view the accounts zones.
    dnsZonesAllowByDefault boolean
    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
    dnsZonesAllows string[]
    List of zones that the user may access.
    dnsZonesDenies string[]
    List of zones that the user may not access.
    ipWhitelistStrict boolean
    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.
    ipWhitelists string[]
    Array of IP addresses/networks to which to grant the user access.
    ipamManageIpam boolean
    Whether the user can manage IPAM. Only relevant for the DDI product.
    ipamViewIpam boolean
    monitoringManageJobs boolean
    Whether the user can modify monitoring jobs.
    monitoringManageLists boolean
    Whether the user can modify notification lists.
    monitoringViewJobs boolean
    Whether the user can view monitoring jobs.
    name string
    The free form name of the user.
    notify {[key: string]: any}
    Whether or not to notify the user of specified events. Only billing is available currently.
    securityManageActiveDirectory boolean
    Whether the user can manage global active directory. Only relevant for the DDI product.
    securityManageGlobal2fa boolean
    Whether the user can manage global two factor authentication.
    teams string[]
    The teams that the user belongs to.
    email str
    The email address of the user.
    username str
    The users login name.
    account_manage_account_settings bool
    Whether the user can modify account settings.
    account_manage_apikeys bool
    Whether the user can modify account apikeys.
    account_manage_ip_whitelist bool
    Whether the user can manage ip whitelist.
    account_manage_payment_methods bool
    Whether the user can modify account payment methods.
    account_manage_plan bool
    No longer in use.

    Deprecated:obsolete, should no longer be used

    account_manage_teams bool
    Whether the user can modify other teams in the account.
    account_manage_users bool
    Whether the user can modify account users.
    account_view_activity_log bool
    Whether the user can view activity logs.
    account_view_invoices bool
    Whether the user can view invoices.
    data_manage_datafeeds bool
    Whether the user can modify data feeds.
    data_manage_datasources bool
    Whether the user can modify data sources.
    data_push_to_datafeeds bool
    Whether the user can publish to data feeds.
    dhcp_manage_dhcp bool
    Whether the user can manage DHCP. Only relevant for the DDI product.
    dhcp_view_dhcp bool
    Whether the user can view DHCP. Only relevant for the DDI product.
    dns_manage_zones bool
    Whether the user can modify the accounts zones.
    dns_records_allows Sequence[UserDnsRecordsAllowArgs]
    dns_records_denies Sequence[UserDnsRecordsDenyArgs]
    dns_view_zones bool
    Whether the user can view the accounts zones.
    dns_zones_allow_by_default bool
    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
    dns_zones_allows Sequence[str]
    List of zones that the user may access.
    dns_zones_denies Sequence[str]
    List of zones that the user may not access.
    ip_whitelist_strict bool
    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.
    ip_whitelists Sequence[str]
    Array of IP addresses/networks to which to grant the user access.
    ipam_manage_ipam bool
    Whether the user can manage IPAM. Only relevant for the DDI product.
    ipam_view_ipam bool
    monitoring_manage_jobs bool
    Whether the user can modify monitoring jobs.
    monitoring_manage_lists bool
    Whether the user can modify notification lists.
    monitoring_view_jobs bool
    Whether the user can view monitoring jobs.
    name str
    The free form name of the user.
    notify Mapping[str, Any]
    Whether or not to notify the user of specified events. Only billing is available currently.
    security_manage_active_directory bool
    Whether the user can manage global active directory. Only relevant for the DDI product.
    security_manage_global2fa bool
    Whether the user can manage global two factor authentication.
    teams Sequence[str]
    The teams that the user belongs to.
    email String
    The email address of the user.
    username String
    The users login name.
    accountManageAccountSettings Boolean
    Whether the user can modify account settings.
    accountManageApikeys Boolean
    Whether the user can modify account apikeys.
    accountManageIpWhitelist Boolean
    Whether the user can manage ip whitelist.
    accountManagePaymentMethods Boolean
    Whether the user can modify account payment methods.
    accountManagePlan Boolean
    No longer in use.

    Deprecated:obsolete, should no longer be used

    accountManageTeams Boolean
    Whether the user can modify other teams in the account.
    accountManageUsers Boolean
    Whether the user can modify account users.
    accountViewActivityLog Boolean
    Whether the user can view activity logs.
    accountViewInvoices Boolean
    Whether the user can view invoices.
    dataManageDatafeeds Boolean
    Whether the user can modify data feeds.
    dataManageDatasources Boolean
    Whether the user can modify data sources.
    dataPushToDatafeeds Boolean
    Whether the user can publish to data feeds.
    dhcpManageDhcp Boolean
    Whether the user can manage DHCP. Only relevant for the DDI product.
    dhcpViewDhcp Boolean
    Whether the user can view DHCP. Only relevant for the DDI product.
    dnsManageZones Boolean
    Whether the user can modify the accounts zones.
    dnsRecordsAllows List<Property Map>
    dnsRecordsDenies List<Property Map>
    dnsViewZones Boolean
    Whether the user can view the accounts zones.
    dnsZonesAllowByDefault Boolean
    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
    dnsZonesAllows List<String>
    List of zones that the user may access.
    dnsZonesDenies List<String>
    List of zones that the user may not access.
    ipWhitelistStrict Boolean
    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.
    ipWhitelists List<String>
    Array of IP addresses/networks to which to grant the user access.
    ipamManageIpam Boolean
    Whether the user can manage IPAM. Only relevant for the DDI product.
    ipamViewIpam Boolean
    monitoringManageJobs Boolean
    Whether the user can modify monitoring jobs.
    monitoringManageLists Boolean
    Whether the user can modify notification lists.
    monitoringViewJobs Boolean
    Whether the user can view monitoring jobs.
    name String
    The free form name of the user.
    notify Map<Any>
    Whether or not to notify the user of specified events. Only billing is available currently.
    securityManageActiveDirectory Boolean
    Whether the user can manage global active directory. Only relevant for the DDI product.
    securityManageGlobal2fa Boolean
    Whether the user can manage global two factor authentication.
    teams List<String>
    The teams that the user belongs to.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing User Resource

    Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UserState, opts?: CustomResourceOptions): User
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_manage_account_settings: Optional[bool] = None,
            account_manage_apikeys: Optional[bool] = None,
            account_manage_ip_whitelist: Optional[bool] = None,
            account_manage_payment_methods: Optional[bool] = None,
            account_manage_plan: Optional[bool] = None,
            account_manage_teams: Optional[bool] = None,
            account_manage_users: Optional[bool] = None,
            account_view_activity_log: Optional[bool] = None,
            account_view_invoices: Optional[bool] = None,
            data_manage_datafeeds: Optional[bool] = None,
            data_manage_datasources: Optional[bool] = None,
            data_push_to_datafeeds: Optional[bool] = None,
            dhcp_manage_dhcp: Optional[bool] = None,
            dhcp_view_dhcp: Optional[bool] = None,
            dns_manage_zones: Optional[bool] = None,
            dns_records_allows: Optional[Sequence[UserDnsRecordsAllowArgs]] = None,
            dns_records_denies: Optional[Sequence[UserDnsRecordsDenyArgs]] = None,
            dns_view_zones: Optional[bool] = None,
            dns_zones_allow_by_default: Optional[bool] = None,
            dns_zones_allows: Optional[Sequence[str]] = None,
            dns_zones_denies: Optional[Sequence[str]] = None,
            email: Optional[str] = None,
            ip_whitelist_strict: Optional[bool] = None,
            ip_whitelists: Optional[Sequence[str]] = None,
            ipam_manage_ipam: Optional[bool] = None,
            ipam_view_ipam: Optional[bool] = None,
            monitoring_manage_jobs: Optional[bool] = None,
            monitoring_manage_lists: Optional[bool] = None,
            monitoring_view_jobs: Optional[bool] = None,
            name: Optional[str] = None,
            notify: Optional[Mapping[str, Any]] = None,
            security_manage_active_directory: Optional[bool] = None,
            security_manage_global2fa: Optional[bool] = None,
            teams: Optional[Sequence[str]] = None,
            username: Optional[str] = None) -> User
    func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
    public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
    public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountManageAccountSettings bool
    Whether the user can modify account settings.
    AccountManageApikeys bool
    Whether the user can modify account apikeys.
    AccountManageIpWhitelist bool
    Whether the user can manage ip whitelist.
    AccountManagePaymentMethods bool
    Whether the user can modify account payment methods.
    AccountManagePlan bool
    No longer in use.

    Deprecated:obsolete, should no longer be used

    AccountManageTeams bool
    Whether the user can modify other teams in the account.
    AccountManageUsers bool
    Whether the user can modify account users.
    AccountViewActivityLog bool
    Whether the user can view activity logs.
    AccountViewInvoices bool
    Whether the user can view invoices.
    DataManageDatafeeds bool
    Whether the user can modify data feeds.
    DataManageDatasources bool
    Whether the user can modify data sources.
    DataPushToDatafeeds bool
    Whether the user can publish to data feeds.
    DhcpManageDhcp bool
    Whether the user can manage DHCP. Only relevant for the DDI product.
    DhcpViewDhcp bool
    Whether the user can view DHCP. Only relevant for the DDI product.
    DnsManageZones bool
    Whether the user can modify the accounts zones.
    DnsRecordsAllows List<UserDnsRecordsAllow>
    DnsRecordsDenies List<UserDnsRecordsDeny>
    DnsViewZones bool
    Whether the user can view the accounts zones.
    DnsZonesAllowByDefault bool
    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
    DnsZonesAllows List<string>
    List of zones that the user may access.
    DnsZonesDenies List<string>
    List of zones that the user may not access.
    Email string
    The email address of the user.
    IpWhitelistStrict bool
    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.
    IpWhitelists List<string>
    Array of IP addresses/networks to which to grant the user access.
    IpamManageIpam bool
    Whether the user can manage IPAM. Only relevant for the DDI product.
    IpamViewIpam bool
    MonitoringManageJobs bool
    Whether the user can modify monitoring jobs.
    MonitoringManageLists bool
    Whether the user can modify notification lists.
    MonitoringViewJobs bool
    Whether the user can view monitoring jobs.
    Name string
    The free form name of the user.
    Notify Dictionary<string, object>
    Whether or not to notify the user of specified events. Only billing is available currently.
    SecurityManageActiveDirectory bool
    Whether the user can manage global active directory. Only relevant for the DDI product.
    SecurityManageGlobal2fa bool
    Whether the user can manage global two factor authentication.
    Teams List<string>
    The teams that the user belongs to.
    Username string
    The users login name.
    AccountManageAccountSettings bool
    Whether the user can modify account settings.
    AccountManageApikeys bool
    Whether the user can modify account apikeys.
    AccountManageIpWhitelist bool
    Whether the user can manage ip whitelist.
    AccountManagePaymentMethods bool
    Whether the user can modify account payment methods.
    AccountManagePlan bool
    No longer in use.

    Deprecated:obsolete, should no longer be used

    AccountManageTeams bool
    Whether the user can modify other teams in the account.
    AccountManageUsers bool
    Whether the user can modify account users.
    AccountViewActivityLog bool
    Whether the user can view activity logs.
    AccountViewInvoices bool
    Whether the user can view invoices.
    DataManageDatafeeds bool
    Whether the user can modify data feeds.
    DataManageDatasources bool
    Whether the user can modify data sources.
    DataPushToDatafeeds bool
    Whether the user can publish to data feeds.
    DhcpManageDhcp bool
    Whether the user can manage DHCP. Only relevant for the DDI product.
    DhcpViewDhcp bool
    Whether the user can view DHCP. Only relevant for the DDI product.
    DnsManageZones bool
    Whether the user can modify the accounts zones.
    DnsRecordsAllows []UserDnsRecordsAllowArgs
    DnsRecordsDenies []UserDnsRecordsDenyArgs
    DnsViewZones bool
    Whether the user can view the accounts zones.
    DnsZonesAllowByDefault bool
    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
    DnsZonesAllows []string
    List of zones that the user may access.
    DnsZonesDenies []string
    List of zones that the user may not access.
    Email string
    The email address of the user.
    IpWhitelistStrict bool
    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.
    IpWhitelists []string
    Array of IP addresses/networks to which to grant the user access.
    IpamManageIpam bool
    Whether the user can manage IPAM. Only relevant for the DDI product.
    IpamViewIpam bool
    MonitoringManageJobs bool
    Whether the user can modify monitoring jobs.
    MonitoringManageLists bool
    Whether the user can modify notification lists.
    MonitoringViewJobs bool
    Whether the user can view monitoring jobs.
    Name string
    The free form name of the user.
    Notify map[string]interface{}
    Whether or not to notify the user of specified events. Only billing is available currently.
    SecurityManageActiveDirectory bool
    Whether the user can manage global active directory. Only relevant for the DDI product.
    SecurityManageGlobal2fa bool
    Whether the user can manage global two factor authentication.
    Teams []string
    The teams that the user belongs to.
    Username string
    The users login name.
    accountManageAccountSettings Boolean
    Whether the user can modify account settings.
    accountManageApikeys Boolean
    Whether the user can modify account apikeys.
    accountManageIpWhitelist Boolean
    Whether the user can manage ip whitelist.
    accountManagePaymentMethods Boolean
    Whether the user can modify account payment methods.
    accountManagePlan Boolean
    No longer in use.

    Deprecated:obsolete, should no longer be used

    accountManageTeams Boolean
    Whether the user can modify other teams in the account.
    accountManageUsers Boolean
    Whether the user can modify account users.
    accountViewActivityLog Boolean
    Whether the user can view activity logs.
    accountViewInvoices Boolean
    Whether the user can view invoices.
    dataManageDatafeeds Boolean
    Whether the user can modify data feeds.
    dataManageDatasources Boolean
    Whether the user can modify data sources.
    dataPushToDatafeeds Boolean
    Whether the user can publish to data feeds.
    dhcpManageDhcp Boolean
    Whether the user can manage DHCP. Only relevant for the DDI product.
    dhcpViewDhcp Boolean
    Whether the user can view DHCP. Only relevant for the DDI product.
    dnsManageZones Boolean
    Whether the user can modify the accounts zones.
    dnsRecordsAllows List<UserDnsRecordsAllow>
    dnsRecordsDenies List<UserDnsRecordsDeny>
    dnsViewZones Boolean
    Whether the user can view the accounts zones.
    dnsZonesAllowByDefault Boolean
    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
    dnsZonesAllows List<String>
    List of zones that the user may access.
    dnsZonesDenies List<String>
    List of zones that the user may not access.
    email String
    The email address of the user.
    ipWhitelistStrict Boolean
    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.
    ipWhitelists List<String>
    Array of IP addresses/networks to which to grant the user access.
    ipamManageIpam Boolean
    Whether the user can manage IPAM. Only relevant for the DDI product.
    ipamViewIpam Boolean
    monitoringManageJobs Boolean
    Whether the user can modify monitoring jobs.
    monitoringManageLists Boolean
    Whether the user can modify notification lists.
    monitoringViewJobs Boolean
    Whether the user can view monitoring jobs.
    name String
    The free form name of the user.
    notify_ Map<String,Object>
    Whether or not to notify the user of specified events. Only billing is available currently.
    securityManageActiveDirectory Boolean
    Whether the user can manage global active directory. Only relevant for the DDI product.
    securityManageGlobal2fa Boolean
    Whether the user can manage global two factor authentication.
    teams List<String>
    The teams that the user belongs to.
    username String
    The users login name.
    accountManageAccountSettings boolean
    Whether the user can modify account settings.
    accountManageApikeys boolean
    Whether the user can modify account apikeys.
    accountManageIpWhitelist boolean
    Whether the user can manage ip whitelist.
    accountManagePaymentMethods boolean
    Whether the user can modify account payment methods.
    accountManagePlan boolean
    No longer in use.

    Deprecated:obsolete, should no longer be used

    accountManageTeams boolean
    Whether the user can modify other teams in the account.
    accountManageUsers boolean
    Whether the user can modify account users.
    accountViewActivityLog boolean
    Whether the user can view activity logs.
    accountViewInvoices boolean
    Whether the user can view invoices.
    dataManageDatafeeds boolean
    Whether the user can modify data feeds.
    dataManageDatasources boolean
    Whether the user can modify data sources.
    dataPushToDatafeeds boolean
    Whether the user can publish to data feeds.
    dhcpManageDhcp boolean
    Whether the user can manage DHCP. Only relevant for the DDI product.
    dhcpViewDhcp boolean
    Whether the user can view DHCP. Only relevant for the DDI product.
    dnsManageZones boolean
    Whether the user can modify the accounts zones.
    dnsRecordsAllows UserDnsRecordsAllow[]
    dnsRecordsDenies UserDnsRecordsDeny[]
    dnsViewZones boolean
    Whether the user can view the accounts zones.
    dnsZonesAllowByDefault boolean
    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
    dnsZonesAllows string[]
    List of zones that the user may access.
    dnsZonesDenies string[]
    List of zones that the user may not access.
    email string
    The email address of the user.
    ipWhitelistStrict boolean
    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.
    ipWhitelists string[]
    Array of IP addresses/networks to which to grant the user access.
    ipamManageIpam boolean
    Whether the user can manage IPAM. Only relevant for the DDI product.
    ipamViewIpam boolean
    monitoringManageJobs boolean
    Whether the user can modify monitoring jobs.
    monitoringManageLists boolean
    Whether the user can modify notification lists.
    monitoringViewJobs boolean
    Whether the user can view monitoring jobs.
    name string
    The free form name of the user.
    notify {[key: string]: any}
    Whether or not to notify the user of specified events. Only billing is available currently.
    securityManageActiveDirectory boolean
    Whether the user can manage global active directory. Only relevant for the DDI product.
    securityManageGlobal2fa boolean
    Whether the user can manage global two factor authentication.
    teams string[]
    The teams that the user belongs to.
    username string
    The users login name.
    account_manage_account_settings bool
    Whether the user can modify account settings.
    account_manage_apikeys bool
    Whether the user can modify account apikeys.
    account_manage_ip_whitelist bool
    Whether the user can manage ip whitelist.
    account_manage_payment_methods bool
    Whether the user can modify account payment methods.
    account_manage_plan bool
    No longer in use.

    Deprecated:obsolete, should no longer be used

    account_manage_teams bool
    Whether the user can modify other teams in the account.
    account_manage_users bool
    Whether the user can modify account users.
    account_view_activity_log bool
    Whether the user can view activity logs.
    account_view_invoices bool
    Whether the user can view invoices.
    data_manage_datafeeds bool
    Whether the user can modify data feeds.
    data_manage_datasources bool
    Whether the user can modify data sources.
    data_push_to_datafeeds bool
    Whether the user can publish to data feeds.
    dhcp_manage_dhcp bool
    Whether the user can manage DHCP. Only relevant for the DDI product.
    dhcp_view_dhcp bool
    Whether the user can view DHCP. Only relevant for the DDI product.
    dns_manage_zones bool
    Whether the user can modify the accounts zones.
    dns_records_allows Sequence[UserDnsRecordsAllowArgs]
    dns_records_denies Sequence[UserDnsRecordsDenyArgs]
    dns_view_zones bool
    Whether the user can view the accounts zones.
    dns_zones_allow_by_default bool
    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
    dns_zones_allows Sequence[str]
    List of zones that the user may access.
    dns_zones_denies Sequence[str]
    List of zones that the user may not access.
    email str
    The email address of the user.
    ip_whitelist_strict bool
    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.
    ip_whitelists Sequence[str]
    Array of IP addresses/networks to which to grant the user access.
    ipam_manage_ipam bool
    Whether the user can manage IPAM. Only relevant for the DDI product.
    ipam_view_ipam bool
    monitoring_manage_jobs bool
    Whether the user can modify monitoring jobs.
    monitoring_manage_lists bool
    Whether the user can modify notification lists.
    monitoring_view_jobs bool
    Whether the user can view monitoring jobs.
    name str
    The free form name of the user.
    notify Mapping[str, Any]
    Whether or not to notify the user of specified events. Only billing is available currently.
    security_manage_active_directory bool
    Whether the user can manage global active directory. Only relevant for the DDI product.
    security_manage_global2fa bool
    Whether the user can manage global two factor authentication.
    teams Sequence[str]
    The teams that the user belongs to.
    username str
    The users login name.
    accountManageAccountSettings Boolean
    Whether the user can modify account settings.
    accountManageApikeys Boolean
    Whether the user can modify account apikeys.
    accountManageIpWhitelist Boolean
    Whether the user can manage ip whitelist.
    accountManagePaymentMethods Boolean
    Whether the user can modify account payment methods.
    accountManagePlan Boolean
    No longer in use.

    Deprecated:obsolete, should no longer be used

    accountManageTeams Boolean
    Whether the user can modify other teams in the account.
    accountManageUsers Boolean
    Whether the user can modify account users.
    accountViewActivityLog Boolean
    Whether the user can view activity logs.
    accountViewInvoices Boolean
    Whether the user can view invoices.
    dataManageDatafeeds Boolean
    Whether the user can modify data feeds.
    dataManageDatasources Boolean
    Whether the user can modify data sources.
    dataPushToDatafeeds Boolean
    Whether the user can publish to data feeds.
    dhcpManageDhcp Boolean
    Whether the user can manage DHCP. Only relevant for the DDI product.
    dhcpViewDhcp Boolean
    Whether the user can view DHCP. Only relevant for the DDI product.
    dnsManageZones Boolean
    Whether the user can modify the accounts zones.
    dnsRecordsAllows List<Property Map>
    dnsRecordsDenies List<Property Map>
    dnsViewZones Boolean
    Whether the user can view the accounts zones.
    dnsZonesAllowByDefault Boolean
    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
    dnsZonesAllows List<String>
    List of zones that the user may access.
    dnsZonesDenies List<String>
    List of zones that the user may not access.
    email String
    The email address of the user.
    ipWhitelistStrict Boolean
    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.
    ipWhitelists List<String>
    Array of IP addresses/networks to which to grant the user access.
    ipamManageIpam Boolean
    Whether the user can manage IPAM. Only relevant for the DDI product.
    ipamViewIpam Boolean
    monitoringManageJobs Boolean
    Whether the user can modify monitoring jobs.
    monitoringManageLists Boolean
    Whether the user can modify notification lists.
    monitoringViewJobs Boolean
    Whether the user can view monitoring jobs.
    name String
    The free form name of the user.
    notify Map<Any>
    Whether or not to notify the user of specified events. Only billing is available currently.
    securityManageActiveDirectory Boolean
    Whether the user can manage global active directory. Only relevant for the DDI product.
    securityManageGlobal2fa Boolean
    Whether the user can manage global two factor authentication.
    teams List<String>
    The teams that the user belongs to.
    username String
    The users login name.

    Supporting Types

    UserDnsRecordsAllow, UserDnsRecordsAllowArgs

    Domain string
    IncludeSubdomains bool
    Type string
    Zone string
    Domain string
    IncludeSubdomains bool
    Type string
    Zone string
    domain String
    includeSubdomains Boolean
    type String
    zone String
    domain string
    includeSubdomains boolean
    type string
    zone string
    domain String
    includeSubdomains Boolean
    type String
    zone String

    UserDnsRecordsDeny, UserDnsRecordsDenyArgs

    Domain string
    IncludeSubdomains bool
    Type string
    Zone string
    Domain string
    IncludeSubdomains bool
    Type string
    Zone string
    domain String
    includeSubdomains Boolean
    type String
    zone String
    domain string
    includeSubdomains boolean
    type string
    zone string
    domain String
    includeSubdomains Boolean
    type String
    zone String

    Import

     $ pulumi import ns1:index/user:User <name> <username>`
    

    Package Details

    Repository
    NS1 pulumi/pulumi-ns1
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ns1 Terraform Provider.
    ns1 logo
    NS1 v3.1.5 published on Friday, Jan 19, 2024 by Pulumi