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,
});
import pulumi
import pulumi_octopusdeploy as octopusdeploy
example = octopusdeploy.get_users(ids=[
"Users-123",
"Users-321",
],
skip=5,
take=100)
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
})
}
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,
});
});
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());
}
}
variables:
example:
fn::invoke:
function: octopusdeploy:getUsers
arguments:
ids:
- Users-123
- Users-321
skip: 5
take: 100
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>
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]
func GetUsers(ctx *Context, args *GetUsersArgs, opts ...InvokeOption) (*GetUsersResult, error)
func GetUsersOutput(ctx *Context, args *GetUsersOutputArgs, opts ...InvokeOption) GetUsersResultOutput
> 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)
}
public static CompletableFuture<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)
public static Output<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)
fn::invoke:
function: octopusdeploy:index/getUsers:getUsers
arguments:
# arguments dictionary
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.
- Space
Id string - The space ID associated with this user.
- 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.
- Space
Id string - The space ID associated with this user.
- 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.
- space
Id String - The space ID associated with this user.
- 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.
- space
Id string - The space ID associated with this user.
- 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.
- 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.
- space
Id String - The space ID associated with this user.
- 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<Get
Users User> - 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.
- Space
Id string - The space ID associated with this user.
- 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
[]Get
Users User - 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.
- Space
Id string - The space ID associated with this user.
- 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<Get
Users User> - 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.
- space
Id String - The space ID associated with this user.
- 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
Get
Users User[] - 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.
- space
Id string - The space ID associated with this user.
- 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[Get
Users User] - 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.
- 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.
- space
Id String - The space ID associated with this user.
- take Number
- A filter to specify the number of items to take (or return) in the response.
Supporting Types
GetUsersUser
- Can
Password Be Edited This property is required. bool - Specifies whether or not the password can be edited.
- Display
Name This property is required. string - The display name of this resource.
- Id
This property is required. string - 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. string - The username associated with this resource.
- Email
Address string - The email address of this resource.
- Identities
List<Get
Users User Identity> - 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. string - The display name of this resource.
- Id
This property is required. string - 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. string - The username associated with this resource.
- Email
Address string - The email address of this resource.
- Identities
[]Get
Users User Identity - The identities associated with the user.
- can
Password Be Edited This property is required. Boolean - Specifies whether or not the password can be edited.
- display
Name This property is required. String - The display name of this resource.
- id
This property is required. String - The unique ID for this resource.
- is
Active This property is required. Boolean - Specifies whether or not the user is active.
- is
Requestor This property is required. Boolean - Specifies whether or not the user is the requestor.
- is
Service 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.
- email
Address String - The email address of this resource.
- identities
List<Get
Users User Identity> - The identities associated with the user.
- can
Password Be Edited This property is required. boolean - Specifies whether or not the password can be edited.
- display
Name This property is required. string - The display name of this resource.
- id
This property is required. string - The unique ID for this resource.
- is
Active This property is required. boolean - Specifies whether or not the user is active.
- is
Requestor This property is required. boolean - Specifies whether or not the user is the requestor.
- is
Service 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.
- email
Address string - The email address of this resource.
- identities
Get
Users User Identity[] - 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[Get
Users User Identity] - The identities associated with the user.
- can
Password Be Edited This property is required. Boolean - Specifies whether or not the password can be edited.
- display
Name This property is required. String - The display name of this resource.
- id
This property is required. String - The unique ID for this resource.
- is
Active This property is required. Boolean - Specifies whether or not the user is active.
- is
Requestor This property is required. Boolean - Specifies whether or not the user is the requestor.
- is
Service 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.
- email
Address String - The email address of this resource.
- identities List<Property Map>
- The identities associated with the user.
GetUsersUserIdentity
- Claims
This property is required. List<GetUsers User Identity Claim> - The claim associated with the identity.
- Provider
This property is required. string - The identity provider.
- Claims
This property is required. []GetUsers User Identity Claim - The claim associated with the identity.
- Provider
This property is required. string - The identity provider.
- claims
This property is required. List<GetUsers User Identity Claim> - The claim associated with the identity.
- provider
This property is required. String - The identity provider.
- claims
This property is required. GetUsers User Identity Claim[] - The claim associated with the identity.
- provider
This property is required. string - The identity provider.
- claims
This property is required. Sequence[GetUsers User Identity Claim] - 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
- Is
Identifying Claim 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.
- Is
Identifying Claim 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.
- is
Identifying Claim 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. 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.
- is
Identifying Claim 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