Docs Packages
  1. Packages
  2. Keycloak
  3. API Docs
  4. GroupPermissions
Keycloak v5.3.1 published on Monday, Mar 11, 2024 by Pulumi
pulumi/pulumi-keycloak

keycloak.GroupPermissions

Explore with Pulumi AI

keycloak logo
Keycloak v5.3.1 published on Monday, Mar 11, 2024 by Pulumi
pulumi/pulumi-keycloak

    Allows you to manage all group Scope Based Permissions https://www.keycloak.org/docs/latest/server_admin/#group.

    This is part of a preview Keycloak feature: admin_fine_grained_authz (see https://www.keycloak.org/docs/latest/server_admin/#_fine_grain_permissions). This feature can be enabled with the Keycloak option -Dkeycloak.profile.feature.admin_fine_grained_authz=enabled. See the example docker-compose.yml file for an example.

    When enabling Roles Permissions, Keycloak does several things automatically:

    1. Enable Authorization on built-in realm-management client (if not already enabled).
    2. Create a resource representing the role permissions.
    3. Create scopes view, manage, view-members, manage-members, manage-membership.
    4. Create all scope based permission for the scopes and role resource

    Create GroupPermissions Resource

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

    Constructor syntax

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

@overload
def GroupPermissions(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     group_id: Optional[str] = None,
                     realm_id: Optional[str] = None,
                     manage_members_scope: Optional[GroupPermissionsManageMembersScopeArgs] = None,
                     manage_membership_scope: Optional[GroupPermissionsManageMembershipScopeArgs] = None,
                     manage_scope: Optional[GroupPermissionsManageScopeArgs] = None,
                     view_members_scope: Optional[GroupPermissionsViewMembersScopeArgs] = None,
                     view_scope: Optional[GroupPermissionsViewScopeArgs] = None)
    func NewGroupPermissions(ctx *Context, name string, args GroupPermissionsArgs, opts ...ResourceOption) (*GroupPermissions, error)
    public GroupPermissions(string name, GroupPermissionsArgs args, CustomResourceOptions? opts = null)
    public GroupPermissions(String name, GroupPermissionsArgs args)
public GroupPermissions(String name, GroupPermissionsArgs args, CustomResourceOptions options)

    type: keycloak:GroupPermissions
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 GroupPermissionsArgs
    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 GroupPermissionsArgs
    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 GroupPermissionsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupPermissionsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupPermissionsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var groupPermissionsResource = new Keycloak.GroupPermissions("groupPermissionsResource", new()
{
    GroupId = "string",
    RealmId = "string",
    ManageMembersScope = new Keycloak.Inputs.GroupPermissionsManageMembersScopeArgs
    {
        DecisionStrategy = "string",
        Description = "string",
        Policies = new[]
        {
            "string",
        },
    },
    ManageMembershipScope = new Keycloak.Inputs.GroupPermissionsManageMembershipScopeArgs
    {
        DecisionStrategy = "string",
        Description = "string",
        Policies = new[]
        {
            "string",
        },
    },
    ManageScope = new Keycloak.Inputs.GroupPermissionsManageScopeArgs
    {
        DecisionStrategy = "string",
        Description = "string",
        Policies = new[]
        {
            "string",
        },
    },
    ViewMembersScope = new Keycloak.Inputs.GroupPermissionsViewMembersScopeArgs
    {
        DecisionStrategy = "string",
        Description = "string",
        Policies = new[]
        {
            "string",
        },
    },
    ViewScope = new Keycloak.Inputs.GroupPermissionsViewScopeArgs
    {
        DecisionStrategy = "string",
        Description = "string",
        Policies = new[]
        {
            "string",
        },
    },
});

    example, err := keycloak.NewGroupPermissions(ctx, "groupPermissionsResource", &keycloak.GroupPermissionsArgs{
	GroupId: pulumi.String("string"),
	RealmId: pulumi.String("string"),
	ManageMembersScope: &keycloak.GroupPermissionsManageMembersScopeArgs{
		DecisionStrategy: pulumi.String("string"),
		Description:      pulumi.String("string"),
		Policies: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	ManageMembershipScope: &keycloak.GroupPermissionsManageMembershipScopeArgs{
		DecisionStrategy: pulumi.String("string"),
		Description:      pulumi.String("string"),
		Policies: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	ManageScope: &keycloak.GroupPermissionsManageScopeArgs{
		DecisionStrategy: pulumi.String("string"),
		Description:      pulumi.String("string"),
		Policies: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	ViewMembersScope: &keycloak.GroupPermissionsViewMembersScopeArgs{
		DecisionStrategy: pulumi.String("string"),
		Description:      pulumi.String("string"),
		Policies: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	ViewScope: &keycloak.GroupPermissionsViewScopeArgs{
		DecisionStrategy: pulumi.String("string"),
		Description:      pulumi.String("string"),
		Policies: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})

    var groupPermissionsResource = new GroupPermissions("groupPermissionsResource", GroupPermissionsArgs.builder()        
    .groupId("string")
    .realmId("string")
    .manageMembersScope(GroupPermissionsManageMembersScopeArgs.builder()
        .decisionStrategy("string")
        .description("string")
        .policies("string")
        .build())
    .manageMembershipScope(GroupPermissionsManageMembershipScopeArgs.builder()
        .decisionStrategy("string")
        .description("string")
        .policies("string")
        .build())
    .manageScope(GroupPermissionsManageScopeArgs.builder()
        .decisionStrategy("string")
        .description("string")
        .policies("string")
        .build())
    .viewMembersScope(GroupPermissionsViewMembersScopeArgs.builder()
        .decisionStrategy("string")
        .description("string")
        .policies("string")
        .build())
    .viewScope(GroupPermissionsViewScopeArgs.builder()
        .decisionStrategy("string")
        .description("string")
        .policies("string")
        .build())
    .build());

    group_permissions_resource = keycloak.GroupPermissions("groupPermissionsResource",
    group_id="string",
    realm_id="string",
    manage_members_scope=keycloak.GroupPermissionsManageMembersScopeArgs(
        decision_strategy="string",
        description="string",
        policies=["string"],
    ),
    manage_membership_scope=keycloak.GroupPermissionsManageMembershipScopeArgs(
        decision_strategy="string",
        description="string",
        policies=["string"],
    ),
    manage_scope=keycloak.GroupPermissionsManageScopeArgs(
        decision_strategy="string",
        description="string",
        policies=["string"],
    ),
    view_members_scope=keycloak.GroupPermissionsViewMembersScopeArgs(
        decision_strategy="string",
        description="string",
        policies=["string"],
    ),
    view_scope=keycloak.GroupPermissionsViewScopeArgs(
        decision_strategy="string",
        description="string",
        policies=["string"],
    ))

    const groupPermissionsResource = new keycloak.GroupPermissions("groupPermissionsResource", {
    groupId: "string",
    realmId: "string",
    manageMembersScope: {
        decisionStrategy: "string",
        description: "string",
        policies: ["string"],
    },
    manageMembershipScope: {
        decisionStrategy: "string",
        description: "string",
        policies: ["string"],
    },
    manageScope: {
        decisionStrategy: "string",
        description: "string",
        policies: ["string"],
    },
    viewMembersScope: {
        decisionStrategy: "string",
        description: "string",
        policies: ["string"],
    },
    viewScope: {
        decisionStrategy: "string",
        description: "string",
        policies: ["string"],
    },
});

    type: keycloak:GroupPermissions
properties:
    groupId: string
    manageMembersScope:
        decisionStrategy: string
        description: string
        policies:
            - string
    manageMembershipScope:
        decisionStrategy: string
        description: string
        policies:
            - string
    manageScope:
        decisionStrategy: string
        description: string
        policies:
            - string
    realmId: string
    viewMembersScope:
        decisionStrategy: string
        description: string
        policies:
            - string
    viewScope:
        decisionStrategy: string
        description: string
        policies:
            - string

    GroupPermissions Resource Properties

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

    Inputs

    The GroupPermissions resource accepts the following input properties:

    Outputs

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

    AuthorizationResourceServerId string
    Resource server id representing the realm management client on which this permission is managed
    Enabled bool
    Id string
    The provider-assigned unique ID for this managed resource.
    AuthorizationResourceServerId string
    Resource server id representing the realm management client on which this permission is managed
    Enabled bool
    Id string
    The provider-assigned unique ID for this managed resource.
    authorizationResourceServerId String
    Resource server id representing the realm management client on which this permission is managed
    enabled Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    authorizationResourceServerId string
    Resource server id representing the realm management client on which this permission is managed
    enabled boolean
    id string
    The provider-assigned unique ID for this managed resource.
    authorization_resource_server_id str
    Resource server id representing the realm management client on which this permission is managed
    enabled bool
    id str
    The provider-assigned unique ID for this managed resource.
    authorizationResourceServerId String
    Resource server id representing the realm management client on which this permission is managed
    enabled Boolean
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing GroupPermissions Resource

    Get an existing GroupPermissions 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?: GroupPermissionsState, opts?: CustomResourceOptions): GroupPermissions
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorization_resource_server_id: Optional[str] = None,
        enabled: Optional[bool] = None,
        group_id: Optional[str] = None,
        manage_members_scope: Optional[GroupPermissionsManageMembersScopeArgs] = None,
        manage_membership_scope: Optional[GroupPermissionsManageMembershipScopeArgs] = None,
        manage_scope: Optional[GroupPermissionsManageScopeArgs] = None,
        realm_id: Optional[str] = None,
        view_members_scope: Optional[GroupPermissionsViewMembersScopeArgs] = None,
        view_scope: Optional[GroupPermissionsViewScopeArgs] = None) -> GroupPermissions
    func GetGroupPermissions(ctx *Context, name string, id IDInput, state *GroupPermissionsState, opts ...ResourceOption) (*GroupPermissions, error)
    public static GroupPermissions Get(string name, Input<string> id, GroupPermissionsState? state, CustomResourceOptions? opts = null)
    public static GroupPermissions get(String name, Output<String> id, GroupPermissionsState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    authorizationResourceServerId String
    Resource server id representing the realm management client on which this permission is managed
    enabled Boolean
    groupId String
    manageMembersScope Property Map
    manageMembershipScope Property Map
    manageScope Property Map
    realmId String
    viewMembersScope Property Map
    viewScope Property Map

    Supporting Types

    GroupPermissionsManageMembersScope, GroupPermissionsManageMembersScopeArgs

    DecisionStrategy string
    Description string
    Policies List<string>
    decisionStrategy String
    description String
    policies List<String>
    decisionStrategy String
    description String
    policies List<String>

    GroupPermissionsManageMembershipScope, GroupPermissionsManageMembershipScopeArgs

    DecisionStrategy string
    Description string
    Policies List<string>
    decisionStrategy String
    description String
    policies List<String>
    decisionStrategy String
    description String
    policies List<String>

    GroupPermissionsManageScope, GroupPermissionsManageScopeArgs

    DecisionStrategy string
    Description string
    Policies List<string>
    decisionStrategy String
    description String
    policies List<String>
    decisionStrategy String
    description String
    policies List<String>

    GroupPermissionsViewMembersScope, GroupPermissionsViewMembersScopeArgs

    DecisionStrategy string
    Description string
    Policies List<string>
    decisionStrategy String
    description String
    policies List<String>
    decisionStrategy String
    description String
    policies List<String>

    GroupPermissionsViewScope, GroupPermissionsViewScopeArgs

    DecisionStrategy string
    Description string
    Policies List<string>
    decisionStrategy String
    description String
    policies List<String>
    decisionStrategy String
    description String
    policies List<String>

    Package Details

    Repository
    Keycloak pulumi/pulumi-keycloak
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the keycloak Terraform Provider.
    keycloak logo
    Keycloak v5.3.1 published on Monday, Mar 11, 2024 by Pulumi
    pulumi/pulumi-keycloak