Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Platform Provider
  3. API Docs
  4. ScimUser
platform 2.2.2 published on Thursday, Apr 3, 2025 by jfrog
jfrog/terraform-provider-platform

platform.ScimUser

Explore with Pulumi AI

platform 2.2.2 published on Thursday, Apr 3, 2025 by jfrog
jfrog/terraform-provider-platform

Provides a JFrog SCIM User resource to manage users with the SCIM protocol.

Example Usage

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

const my_scim_user = new platform.ScimUser("my-scim-user", {
    active: true,
    emails: [{
        primary: true,
        value: "test@tempurl.org",
    }],
    username: "test@tempurl.org",
});
Copy
import pulumi
import pulumi_platform as platform

my_scim_user = platform.ScimUser("my-scim-user",
    active=True,
    emails=[{
        "primary": True,
        "value": "test@tempurl.org",
    }],
    username="test@tempurl.org")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := platform.NewScimUser(ctx, "my-scim-user", &platform.ScimUserArgs{
			Active: pulumi.Bool(true),
			Emails: platform.ScimUserEmailArray{
				&platform.ScimUserEmailArgs{
					Primary: pulumi.Bool(true),
					Value:   pulumi.String("test@tempurl.org"),
				},
			},
			Username: pulumi.String("test@tempurl.org"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Platform = Pulumi.Platform;

return await Deployment.RunAsync(() => 
{
    var my_scim_user = new Platform.ScimUser("my-scim-user", new()
    {
        Active = true,
        Emails = new[]
        {
            new Platform.Inputs.ScimUserEmailArgs
            {
                Primary = true,
                Value = "test@tempurl.org",
            },
        },
        Username = "test@tempurl.org",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.platform.ScimUser;
import com.pulumi.platform.ScimUserArgs;
import com.pulumi.platform.inputs.ScimUserEmailArgs;
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 my_scim_user = new ScimUser("my-scim-user", ScimUserArgs.builder()
            .active(true)
            .emails(ScimUserEmailArgs.builder()
                .primary(true)
                .value("test@tempurl.org")
                .build())
            .username("test@tempurl.org")
            .build());

    }
}
Copy
resources:
  my-scim-user:
    type: platform:ScimUser
    properties:
      active: true
      emails:
        - primary: true
          value: test@tempurl.org
      username: test@tempurl.org
Copy

Create ScimUser Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ScimUser(name: string, args: ScimUserArgs, opts?: CustomResourceOptions);
@overload
def ScimUser(resource_name: str,
             args: ScimUserArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def ScimUser(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             emails: Optional[Sequence[ScimUserEmailArgs]] = None,
             username: Optional[str] = None,
             active: Optional[bool] = None)
func NewScimUser(ctx *Context, name string, args ScimUserArgs, opts ...ResourceOption) (*ScimUser, error)
public ScimUser(string name, ScimUserArgs args, CustomResourceOptions? opts = null)
public ScimUser(String name, ScimUserArgs args)
public ScimUser(String name, ScimUserArgs args, CustomResourceOptions options)

type: platform:ScimUser
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ScimUserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ScimUserArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ScimUserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ScimUserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ScimUserArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var scimUserResource = new Platform.ScimUser("scimUserResource", new()
{
    Emails = new[]
    {
        new Platform.Inputs.ScimUserEmailArgs
        {
            Primary = false,
            Value = "string",
        },
    },
    Username = "string",
    Active = false,
});
Copy
example, err := platform.NewScimUser(ctx, "scimUserResource", &platform.ScimUserArgs{
Emails: .ScimUserEmailArray{
&.ScimUserEmailArgs{
Primary: pulumi.Bool(false),
Value: pulumi.String("string"),
},
},
Username: pulumi.String("string"),
Active: pulumi.Bool(false),
})
Copy
var scimUserResource = new ScimUser("scimUserResource", ScimUserArgs.builder()
    .emails(ScimUserEmailArgs.builder()
        .primary(false)
        .value("string")
        .build())
    .username("string")
    .active(false)
    .build());
Copy
scim_user_resource = platform.ScimUser("scimUserResource",
    emails=[{
        "primary": False,
        "value": "string",
    }],
    username="string",
    active=False)
Copy
const scimUserResource = new platform.ScimUser("scimUserResource", {
    emails: [{
        primary: false,
        value: "string",
    }],
    username: "string",
    active: false,
});
Copy
type: platform:ScimUser
properties:
    active: false
    emails:
        - primary: false
          value: string
    username: string
Copy

ScimUser Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ScimUser resource accepts the following input properties:

Emails This property is required. List<ScimUserEmail>
Username This property is required. string
Active bool
Emails This property is required. []ScimUserEmailArgs
Username This property is required. string
Active bool
emails This property is required. List<ScimUserEmail>
username This property is required. String
active Boolean
emails This property is required. ScimUserEmail[]
username This property is required. string
active boolean
emails This property is required. Sequence[ScimUserEmailArgs]
username This property is required. str
active bool
emails This property is required. List<Property Map>
username This property is required. String
active Boolean

Outputs

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

Groups List<ScimUserGroup>
Id string
The provider-assigned unique ID for this managed resource.
Meta Dictionary<string, string>
Groups []ScimUserGroup
Id string
The provider-assigned unique ID for this managed resource.
Meta map[string]string
groups List<ScimUserGroup>
id String
The provider-assigned unique ID for this managed resource.
meta Map<String,String>
groups ScimUserGroup[]
id string
The provider-assigned unique ID for this managed resource.
meta {[key: string]: string}
groups Sequence[ScimUserGroup]
id str
The provider-assigned unique ID for this managed resource.
meta Mapping[str, str]
groups List<Property Map>
id String
The provider-assigned unique ID for this managed resource.
meta Map<String>

Look up Existing ScimUser Resource

Get an existing ScimUser 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?: ScimUserState, opts?: CustomResourceOptions): ScimUser
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        emails: Optional[Sequence[ScimUserEmailArgs]] = None,
        groups: Optional[Sequence[ScimUserGroupArgs]] = None,
        meta: Optional[Mapping[str, str]] = None,
        username: Optional[str] = None) -> ScimUser
func GetScimUser(ctx *Context, name string, id IDInput, state *ScimUserState, opts ...ResourceOption) (*ScimUser, error)
public static ScimUser Get(string name, Input<string> id, ScimUserState? state, CustomResourceOptions? opts = null)
public static ScimUser get(String name, Output<String> id, ScimUserState state, CustomResourceOptions options)
resources:  _:    type: platform:ScimUser    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.

Supporting Types

ScimUserEmail
, ScimUserEmailArgs

Primary This property is required. bool
Value This property is required. string
Primary This property is required. bool
Value This property is required. string
primary This property is required. Boolean
value This property is required. String
primary This property is required. boolean
value This property is required. string
primary This property is required. bool
value This property is required. str
primary This property is required. Boolean
value This property is required. String

ScimUserGroup
, ScimUserGroupArgs

Value This property is required. string
Value This property is required. string
value This property is required. String
value This property is required. string
value This property is required. str
value This property is required. String

Import

$ pulumi import platform:index/scimUser:ScimUser my-scim-user test@tempurl.org
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
platform jfrog/terraform-provider-platform
License
Notes
This Pulumi package is based on the platform Terraform Provider.
platform 2.2.2 published on Thursday, Apr 3, 2025 by jfrog
jfrog/terraform-provider-platform