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

platform logo
platform 2.2.1 published on Friday, Mar 7, 2025 by jfrog

    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",
            },
        ],
    });
    
    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",
            },
        ])
    
    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
    	})
    }
    
    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",
                },
            },
        });
    
    });
    
    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());
    
        }
    }
    
    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
    

    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 string
    The unique name of the resource.
    args ScimGroupArgs
    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 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 string
    The unique name of the resource.
    args ScimGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScimGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
    });
    
    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"),
    })
    
    var scimGroupResource = new ScimGroup("scimGroupResource", ScimGroupArgs.builder()
        .displayName("string")
        .members(ScimGroupMemberArgs.builder()
            .display("string")
            .value("string")
            .build())
        .scimGroupId("string")
        .build());
    
    scim_group_resource = platform.ScimGroup("scimGroupResource",
        display_name="string",
        members=[{
            "display": "string",
            "value": "string",
        }],
        scim_group_id="string")
    
    const scimGroupResource = new platform.ScimGroup("scimGroupResource", {
        displayName: "string",
        members: [{
            display: "string",
            value: "string",
        }],
        scimGroupId: "string",
    });
    
    type: platform:ScimGroup
    properties:
        displayName: string
        members:
            - display: string
              value: string
        scimGroupId: string
    

    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:

    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
    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:
    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 string
    Value string
    Display string
    Value string
    display String
    value String
    display string
    value string
    display str
    value str
    display String
    value String

    Import

    $ pulumi import platform:index/scimGroup:ScimGroup my-scim-group my-scim-group
    

    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 logo
    platform 2.2.1 published on Friday, Mar 7, 2025 by jfrog