1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. getUsers
octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs

octopusdeploy.getUsers

Explore with Pulumi AI

octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs

Provides information about existing users.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as octopusdeploy from "@pulumi/octopusdeploy";

const example = octopusdeploy.getUsers({
    ids: [
        "Users-123",
        "Users-321",
    ],
    skip: 5,
    take: 100,
});
Copy
import pulumi
import pulumi_octopusdeploy as octopusdeploy

example = octopusdeploy.get_users(ids=[
        "Users-123",
        "Users-321",
    ],
    skip=5,
    take=100)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/octopusdeploy/octopusdeploy"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := octopusdeploy.GetUsers(ctx, &octopusdeploy.GetUsersArgs{
			Ids: []string{
				"Users-123",
				"Users-321",
			},
			Skip: pulumi.Float64Ref(5),
			Take: pulumi.Float64Ref(100),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Octopusdeploy = Pulumi.Octopusdeploy;

return await Deployment.RunAsync(() => 
{
    var example = Octopusdeploy.GetUsers.Invoke(new()
    {
        Ids = new[]
        {
            "Users-123",
            "Users-321",
        },
        Skip = 5,
        Take = 100,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.OctopusdeployFunctions;
import com.pulumi.octopusdeploy.inputs.GetUsersArgs;
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 example = OctopusdeployFunctions.getUsers(GetUsersArgs.builder()
            .ids(            
                "Users-123",
                "Users-321")
            .skip(5)
            .take(100)
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: octopusdeploy:getUsers
      arguments:
        ids:
          - Users-123
          - Users-321
        skip: 5
        take: 100
Copy

Using getUsers

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 getUsers(args: GetUsersArgs, opts?: InvokeOptions): Promise<GetUsersResult>
function getUsersOutput(args: GetUsersOutputArgs, opts?: InvokeOptions): Output<GetUsersResult>
Copy
def get_users(filter: Optional[str] = None,
              ids: Optional[Sequence[str]] = None,
              skip: Optional[float] = None,
              space_id: Optional[str] = None,
              take: Optional[float] = None,
              opts: Optional[InvokeOptions] = None) -> GetUsersResult
def get_users_output(filter: Optional[pulumi.Input[str]] = None,
              ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              skip: Optional[pulumi.Input[float]] = None,
              space_id: Optional[pulumi.Input[str]] = None,
              take: Optional[pulumi.Input[float]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetUsersResult]
Copy
func GetUsers(ctx *Context, args *GetUsersArgs, opts ...InvokeOption) (*GetUsersResult, error)
func GetUsersOutput(ctx *Context, args *GetUsersOutputArgs, opts ...InvokeOption) GetUsersResultOutput
Copy

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

public static class GetUsers 
{
    public static Task<GetUsersResult> InvokeAsync(GetUsersArgs args, InvokeOptions? opts = null)
    public static Output<GetUsersResult> Invoke(GetUsersInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)
public static Output<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: octopusdeploy:index/getUsers:getUsers
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Filter string
A filter search by username, display name or email
Ids List<string>
A filter to search by a list of IDs.
Skip double
A filter to specify the number of items to skip in the response.
SpaceId string
The space ID associated with this user.

Deprecated: Deprecated

Take double
A filter to specify the number of items to take (or return) in the response.
Filter string
A filter search by username, display name or email
Ids []string
A filter to search by a list of IDs.
Skip float64
A filter to specify the number of items to skip in the response.
SpaceId string
The space ID associated with this user.

Deprecated: Deprecated

Take float64
A filter to specify the number of items to take (or return) in the response.
filter String
A filter search by username, display name or email
ids List<String>
A filter to search by a list of IDs.
skip Double
A filter to specify the number of items to skip in the response.
spaceId String
The space ID associated with this user.

Deprecated: Deprecated

take Double
A filter to specify the number of items to take (or return) in the response.
filter string
A filter search by username, display name or email
ids string[]
A filter to search by a list of IDs.
skip number
A filter to specify the number of items to skip in the response.
spaceId string
The space ID associated with this user.

Deprecated: Deprecated

take number
A filter to specify the number of items to take (or return) in the response.
filter str
A filter search by username, display name or email
ids Sequence[str]
A filter to search by a list of IDs.
skip float
A filter to specify the number of items to skip in the response.
space_id str
The space ID associated with this user.

Deprecated: Deprecated

take float
A filter to specify the number of items to take (or return) in the response.
filter String
A filter search by username, display name or email
ids List<String>
A filter to search by a list of IDs.
skip Number
A filter to specify the number of items to skip in the response.
spaceId String
The space ID associated with this user.

Deprecated: Deprecated

take Number
A filter to specify the number of items to take (or return) in the response.

getUsers Result

The following output properties are available:

Id string
The unique ID for this resource.
Users List<GetUsersUser>
Filter string
A filter search by username, display name or email
Ids List<string>
A filter to search by a list of IDs.
Skip double
A filter to specify the number of items to skip in the response.
SpaceId string
The space ID associated with this user.

Deprecated: Deprecated

Take double
A filter to specify the number of items to take (or return) in the response.
Id string
The unique ID for this resource.
Users []GetUsersUser
Filter string
A filter search by username, display name or email
Ids []string
A filter to search by a list of IDs.
Skip float64
A filter to specify the number of items to skip in the response.
SpaceId string
The space ID associated with this user.

Deprecated: Deprecated

Take float64
A filter to specify the number of items to take (or return) in the response.
id String
The unique ID for this resource.
users List<GetUsersUser>
filter String
A filter search by username, display name or email
ids List<String>
A filter to search by a list of IDs.
skip Double
A filter to specify the number of items to skip in the response.
spaceId String
The space ID associated with this user.

Deprecated: Deprecated

take Double
A filter to specify the number of items to take (or return) in the response.
id string
The unique ID for this resource.
users GetUsersUser[]
filter string
A filter search by username, display name or email
ids string[]
A filter to search by a list of IDs.
skip number
A filter to specify the number of items to skip in the response.
spaceId string
The space ID associated with this user.

Deprecated: Deprecated

take number
A filter to specify the number of items to take (or return) in the response.
id str
The unique ID for this resource.
users Sequence[GetUsersUser]
filter str
A filter search by username, display name or email
ids Sequence[str]
A filter to search by a list of IDs.
skip float
A filter to specify the number of items to skip in the response.
space_id str
The space ID associated with this user.

Deprecated: Deprecated

take float
A filter to specify the number of items to take (or return) in the response.
id String
The unique ID for this resource.
users List<Property Map>
filter String
A filter search by username, display name or email
ids List<String>
A filter to search by a list of IDs.
skip Number
A filter to specify the number of items to skip in the response.
spaceId String
The space ID associated with this user.

Deprecated: Deprecated

take Number
A filter to specify the number of items to take (or return) in the response.

Supporting Types

GetUsersUser

CanPasswordBeEdited This property is required. bool
Specifies whether or not the password can be edited.
DisplayName This property is required. string
The display name of this resource.
Id This property is required. string
The unique ID for this resource.
IsActive This property is required. bool
Specifies whether or not the user is active.
IsRequestor This property is required. bool
Specifies whether or not the user is the requestor.
IsService This property is required. bool
Specifies whether or not the user is a service account.
Username This property is required. string
The username associated with this resource.
EmailAddress string
The email address of this resource.
Identities List<GetUsersUserIdentity>
The identities associated with the user.
CanPasswordBeEdited This property is required. bool
Specifies whether or not the password can be edited.
DisplayName This property is required. string
The display name of this resource.
Id This property is required. string
The unique ID for this resource.
IsActive This property is required. bool
Specifies whether or not the user is active.
IsRequestor This property is required. bool
Specifies whether or not the user is the requestor.
IsService This property is required. bool
Specifies whether or not the user is a service account.
Username This property is required. string
The username associated with this resource.
EmailAddress string
The email address of this resource.
Identities []GetUsersUserIdentity
The identities associated with the user.
canPasswordBeEdited This property is required. Boolean
Specifies whether or not the password can be edited.
displayName This property is required. String
The display name of this resource.
id This property is required. String
The unique ID for this resource.
isActive This property is required. Boolean
Specifies whether or not the user is active.
isRequestor This property is required. Boolean
Specifies whether or not the user is the requestor.
isService This property is required. Boolean
Specifies whether or not the user is a service account.
username This property is required. String
The username associated with this resource.
emailAddress String
The email address of this resource.
identities List<GetUsersUserIdentity>
The identities associated with the user.
canPasswordBeEdited This property is required. boolean
Specifies whether or not the password can be edited.
displayName This property is required. string
The display name of this resource.
id This property is required. string
The unique ID for this resource.
isActive This property is required. boolean
Specifies whether or not the user is active.
isRequestor This property is required. boolean
Specifies whether or not the user is the requestor.
isService This property is required. boolean
Specifies whether or not the user is a service account.
username This property is required. string
The username associated with this resource.
emailAddress string
The email address of this resource.
identities GetUsersUserIdentity[]
The identities associated with the user.
can_password_be_edited This property is required. bool
Specifies whether or not the password can be edited.
display_name This property is required. str
The display name of this resource.
id This property is required. str
The unique ID for this resource.
is_active This property is required. bool
Specifies whether or not the user is active.
is_requestor This property is required. bool
Specifies whether or not the user is the requestor.
is_service This property is required. bool
Specifies whether or not the user is a service account.
username This property is required. str
The username associated with this resource.
email_address str
The email address of this resource.
identities Sequence[GetUsersUserIdentity]
The identities associated with the user.
canPasswordBeEdited This property is required. Boolean
Specifies whether or not the password can be edited.
displayName This property is required. String
The display name of this resource.
id This property is required. String
The unique ID for this resource.
isActive This property is required. Boolean
Specifies whether or not the user is active.
isRequestor This property is required. Boolean
Specifies whether or not the user is the requestor.
isService This property is required. Boolean
Specifies whether or not the user is a service account.
username This property is required. String
The username associated with this resource.
emailAddress String
The email address of this resource.
identities List<Property Map>
The identities associated with the user.

GetUsersUserIdentity

Claims This property is required. List<GetUsersUserIdentityClaim>
The claim associated with the identity.
Provider This property is required. string
The identity provider.
Claims This property is required. []GetUsersUserIdentityClaim
The claim associated with the identity.
Provider This property is required. string
The identity provider.
claims This property is required. List<GetUsersUserIdentityClaim>
The claim associated with the identity.
provider This property is required. String
The identity provider.
claims This property is required. GetUsersUserIdentityClaim[]
The claim associated with the identity.
provider This property is required. string
The identity provider.
claims This property is required. Sequence[GetUsersUserIdentityClaim]
The claim associated with the identity.
provider This property is required. str
The identity provider.
claims This property is required. List<Property Map>
The claim associated with the identity.
provider This property is required. String
The identity provider.

GetUsersUserIdentityClaim

IsIdentifyingClaim This property is required. bool
Specifies whether or not the claim is an identifying claim.
Name This property is required. string
The name of this resource.
Value This property is required. string
The value of this resource.
IsIdentifyingClaim This property is required. bool
Specifies whether or not the claim is an identifying claim.
Name This property is required. string
The name of this resource.
Value This property is required. string
The value of this resource.
isIdentifyingClaim This property is required. Boolean
Specifies whether or not the claim is an identifying claim.
name This property is required. String
The name of this resource.
value This property is required. String
The value of this resource.
isIdentifyingClaim This property is required. boolean
Specifies whether or not the claim is an identifying claim.
name This property is required. string
The name of this resource.
value This property is required. string
The value of this resource.
is_identifying_claim This property is required. bool
Specifies whether or not the claim is an identifying claim.
name This property is required. str
The name of this resource.
value This property is required. str
The value of this resource.
isIdentifyingClaim This property is required. Boolean
Specifies whether or not the claim is an identifying claim.
name This property is required. String
The name of this resource.
value This property is required. String
The value of this resource.

Package Details

Repository
octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
License
Notes
This Pulumi package is based on the octopusdeploy Terraform Provider.
octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs