1. Packages
  2. Platform Provider
  3. API Docs
  4. ScimGroup
platform 2.2.1 published on Friday, Mar 7, 2025 by jfrog

platform.ScimGroup

Explore with Pulumi AI

Provides a JFrog SCIM Group resource to manage groups with the SCIM protocol.

Example Usage

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

const my_scim_group = new platform.ScimGroup("my-scim-group", {
    displayName: "my-scim-group",
    scimGroupId: "my-scim-group",
    members: [
        {
            display: "test@tempurl.org",
            value: "test@tempurl.org",
        },
        {
            display: "anonymous",
            value: "anonymous",
        },
    ],
});
Copy
import pulumi
import pulumi_platform as platform

my_scim_group = platform.ScimGroup("my-scim-group",
    display_name="my-scim-group",
    scim_group_id="my-scim-group",
    members=[
        {
            "display": "test@tempurl.org",
            "value": "test@tempurl.org",
        },
        {
            "display": "anonymous",
            "value": "anonymous",
        },
    ])
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.NewScimGroup(ctx, "my-scim-group", &platform.ScimGroupArgs{
			DisplayName: pulumi.String("my-scim-group"),
			ScimGroupId: pulumi.String("my-scim-group"),
			Members: platform.ScimGroupMemberArray{
				&platform.ScimGroupMemberArgs{
					Display: pulumi.String("test@tempurl.org"),
					Value:   pulumi.String("test@tempurl.org"),
				},
				&platform.ScimGroupMemberArgs{
					Display: pulumi.String("anonymous"),
					Value:   pulumi.String("anonymous"),
				},
			},
		})
		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_group = new Platform.ScimGroup("my-scim-group", new()
    {
        DisplayName = "my-scim-group",
        ScimGroupId = "my-scim-group",
        Members = new[]
        {
            new Platform.Inputs.ScimGroupMemberArgs
            {
                Display = "test@tempurl.org",
                Value = "test@tempurl.org",
            },
            new Platform.Inputs.ScimGroupMemberArgs
            {
                Display = "anonymous",
                Value = "anonymous",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.platform.ScimGroup;
import com.pulumi.platform.ScimGroupArgs;
import com.pulumi.platform.inputs.ScimGroupMemberArgs;
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_group = new ScimGroup("my-scim-group", ScimGroupArgs.builder()
            .displayName("my-scim-group")
            .scimGroupId("my-scim-group")
            .members(            
                ScimGroupMemberArgs.builder()
                    .display("test@tempurl.org")
                    .value("test@tempurl.org")
                    .build(),
                ScimGroupMemberArgs.builder()
                    .display("anonymous")
                    .value("anonymous")
                    .build())
            .build());

    }
}
Copy
resources:
  my-scim-group:
    type: platform:ScimGroup
    properties:
      displayName: my-scim-group
      scimGroupId: my-scim-group
      members:
        - display: test@tempurl.org
          value: test@tempurl.org
        - display: anonymous
          value: anonymous
Copy

Create ScimGroup Resource

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

Constructor syntax

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

@overload
def ScimGroup(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              display_name: Optional[str] = None,
              members: Optional[Sequence[ScimGroupMemberArgs]] = None,
              scim_group_id: Optional[str] = None)
func NewScimGroup(ctx *Context, name string, args ScimGroupArgs, opts ...ResourceOption) (*ScimGroup, error)
public ScimGroup(string name, ScimGroupArgs args, CustomResourceOptions? opts = null)
public ScimGroup(String name, ScimGroupArgs args)
public ScimGroup(String name, ScimGroupArgs args, CustomResourceOptions options)
type: platform:ScimGroup
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. ScimGroupArgs
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. ScimGroupArgs
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. ScimGroupArgs
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. ScimGroupArgs
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. ScimGroupArgs
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 scimGroupResource = new Platform.ScimGroup("scimGroupResource", new()
{
    DisplayName = "string",
    Members = new[]
    {
        new Platform.Inputs.ScimGroupMemberArgs
        {
            Display = "string",
            Value = "string",
        },
    },
    ScimGroupId = "string",
});
Copy
example, err := platform.NewScimGroup(ctx, "scimGroupResource", &platform.ScimGroupArgs{
DisplayName: pulumi.String("string"),
Members: .ScimGroupMemberArray{
&.ScimGroupMemberArgs{
Display: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
ScimGroupId: pulumi.String("string"),
})
Copy
var scimGroupResource = new ScimGroup("scimGroupResource", ScimGroupArgs.builder()
    .displayName("string")
    .members(ScimGroupMemberArgs.builder()
        .display("string")
        .value("string")
        .build())
    .scimGroupId("string")
    .build());
Copy
scim_group_resource = platform.ScimGroup("scimGroupResource",
    display_name="string",
    members=[{
        "display": "string",
        "value": "string",
    }],
    scim_group_id="string")
Copy
const scimGroupResource = new platform.ScimGroup("scimGroupResource", {
    displayName: "string",
    members: [{
        display: "string",
        value: "string",
    }],
    scimGroupId: "string",
});
Copy
type: platform:ScimGroup
properties:
    displayName: string
    members:
        - display: string
          value: string
    scimGroupId: string
Copy

ScimGroup 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 ScimGroup resource accepts the following input properties:

DisplayName This property is required. string
Members This property is required. List<ScimGroupMember>
ScimGroupId This property is required. string
Group ID
DisplayName This property is required. string
Members This property is required. []ScimGroupMemberArgs
ScimGroupId This property is required. string
Group ID
displayName This property is required. String
members This property is required. List<ScimGroupMember>
scimGroupId This property is required. String
Group ID
displayName This property is required. string
members This property is required. ScimGroupMember[]
scimGroupId This property is required. string
Group ID
display_name This property is required. str
members This property is required. Sequence[ScimGroupMemberArgs]
scim_group_id This property is required. str
Group ID
displayName This property is required. String
members This property is required. List<Property Map>
scimGroupId This property is required. String
Group ID

Outputs

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

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

Look up Existing ScimGroup Resource

Get an existing ScimGroup 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?: ScimGroupState, opts?: CustomResourceOptions): ScimGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        display_name: Optional[str] = None,
        members: Optional[Sequence[ScimGroupMemberArgs]] = None,
        meta: Optional[Mapping[str, str]] = None,
        scim_group_id: Optional[str] = None) -> ScimGroup
func GetScimGroup(ctx *Context, name string, id IDInput, state *ScimGroupState, opts ...ResourceOption) (*ScimGroup, error)
public static ScimGroup Get(string name, Input<string> id, ScimGroupState? state, CustomResourceOptions? opts = null)
public static ScimGroup get(String name, Output<String> id, ScimGroupState state, CustomResourceOptions options)
resources:  _:    type: platform:ScimGroup    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.
The following state arguments are supported:
DisplayName string
Members List<ScimGroupMember>
Meta Dictionary<string, string>
ScimGroupId string
Group ID
DisplayName string
Members []ScimGroupMemberArgs
Meta map[string]string
ScimGroupId string
Group ID
displayName String
members List<ScimGroupMember>
meta Map<String,String>
scimGroupId String
Group ID
displayName string
members ScimGroupMember[]
meta {[key: string]: string}
scimGroupId string
Group ID
displayName String
members List<Property Map>
meta Map<String>
scimGroupId String
Group ID

Supporting Types

ScimGroupMember
, ScimGroupMemberArgs

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

Import

$ pulumi import platform:index/scimGroup:ScimGroup my-scim-group my-scim-group
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.