1. Pulumi Registry
  2. Keycloak
  3. API Docs
  4. GroupPermissions
keycloak logo
Keycloak v5.1.0, Mar 14 23

keycloak.GroupPermissions

Create GroupPermissions Resource

new GroupPermissions(name: string, args: GroupPermissionsArgs, opts?: CustomResourceOptions);
@overload
def GroupPermissions(resource_name: str,
                     opts: Optional[ResourceOptions] = 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)
@overload
def GroupPermissions(resource_name: str,
                     args: GroupPermissionsArgs,
                     opts: Optional[ResourceOptions] = 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.
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.

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

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

GroupPermissionsManageMembershipScope

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

GroupPermissionsManageScope

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

GroupPermissionsViewMembersScope

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

GroupPermissionsViewScope

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.