Keycloak

v4.7.0 published on Thursday, Nov 18, 2021 by Pulumi

GroupRoles

Import

This resource can be imported using the format {{realm_id}}/{{group_id}}, where group_id is the unique ID that Keycloak assigns to the group upon creation. This value can be found in the URI when editing this group in the GUI, and is typically a GUID. Examplebash

 $ pulumi import keycloak:index/groupRoles:GroupRoles group_roles my-realm/18cc6b87-2ce7-4e59-bdc8-b9d49ec98a94

Create a GroupRoles Resource

new GroupRoles(name: string, args: GroupRolesArgs, opts?: CustomResourceOptions);
@overload
def GroupRoles(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               exhaustive: Optional[bool] = None,
               group_id: Optional[str] = None,
               realm_id: Optional[str] = None,
               role_ids: Optional[Sequence[str]] = None)
@overload
def GroupRoles(resource_name: str,
               args: GroupRolesArgs,
               opts: Optional[ResourceOptions] = None)
func NewGroupRoles(ctx *Context, name string, args GroupRolesArgs, opts ...ResourceOption) (*GroupRoles, error)
public GroupRoles(string name, GroupRolesArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args GroupRolesArgs
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 GroupRolesArgs
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 GroupRolesArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GroupRolesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

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

GroupId string
The ID of the group this resource should manage roles for.
RealmId string
The realm this group exists in.
RoleIds List<string>
A list of role IDs to map to the group.
Exhaustive bool
Indicates if the list of roles is exhaustive. In this case, roles that are manually added to the group will be removed. Defaults to true.
GroupId string
The ID of the group this resource should manage roles for.
RealmId string
The realm this group exists in.
RoleIds []string
A list of role IDs to map to the group.
Exhaustive bool
Indicates if the list of roles is exhaustive. In this case, roles that are manually added to the group will be removed. Defaults to true.
groupId string
The ID of the group this resource should manage roles for.
realmId string
The realm this group exists in.
roleIds string[]
A list of role IDs to map to the group.
exhaustive boolean
Indicates if the list of roles is exhaustive. In this case, roles that are manually added to the group will be removed. Defaults to true.
group_id str
The ID of the group this resource should manage roles for.
realm_id str
The realm this group exists in.
role_ids Sequence[str]
A list of role IDs to map to the group.
exhaustive bool
Indicates if the list of roles is exhaustive. In this case, roles that are manually added to the group will be removed. Defaults to true.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing GroupRoles Resource

Get an existing GroupRoles 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?: GroupRolesState, opts?: CustomResourceOptions): GroupRoles
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        exhaustive: Optional[bool] = None,
        group_id: Optional[str] = None,
        realm_id: Optional[str] = None,
        role_ids: Optional[Sequence[str]] = None) -> GroupRoles
func GetGroupRoles(ctx *Context, name string, id IDInput, state *GroupRolesState, opts ...ResourceOption) (*GroupRoles, error)
public static GroupRoles Get(string name, Input<string> id, GroupRolesState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

Exhaustive bool
Indicates if the list of roles is exhaustive. In this case, roles that are manually added to the group will be removed. Defaults to true.
GroupId string
The ID of the group this resource should manage roles for.
RealmId string
The realm this group exists in.
RoleIds List<string>
A list of role IDs to map to the group.
Exhaustive bool
Indicates if the list of roles is exhaustive. In this case, roles that are manually added to the group will be removed. Defaults to true.
GroupId string
The ID of the group this resource should manage roles for.
RealmId string
The realm this group exists in.
RoleIds []string
A list of role IDs to map to the group.
exhaustive boolean
Indicates if the list of roles is exhaustive. In this case, roles that are manually added to the group will be removed. Defaults to true.
groupId string
The ID of the group this resource should manage roles for.
realmId string
The realm this group exists in.
roleIds string[]
A list of role IDs to map to the group.
exhaustive bool
Indicates if the list of roles is exhaustive. In this case, roles that are manually added to the group will be removed. Defaults to true.
group_id str
The ID of the group this resource should manage roles for.
realm_id str
The realm this group exists in.
role_ids Sequence[str]
A list of role IDs to map to the group.

Package Details

Repository
https://github.com/pulumi/pulumi-keycloak
License
Apache-2.0
Notes
This Pulumi package is based on the keycloak Terraform Provider.