1. Docs
  2. Reference
  3. API
  4. Keycloak
  5. ldap
  6. RoleMapper

RoleMapper

Create a RoleMapper Resource

new RoleMapper(name: string, args: RoleMapperArgs, opts?: CustomResourceOptions);
def RoleMapper(resource_name, opts=None, client_id=None, ldap_roles_dn=None, ldap_user_federation_id=None, memberof_ldap_attribute=None, membership_attribute_type=None, membership_ldap_attribute=None, membership_user_ldap_attribute=None, mode=None, name=None, realm_id=None, role_name_ldap_attribute=None, role_object_classes=None, roles_ldap_filter=None, use_realm_roles_mapping=None, user_roles_retrieve_strategy=None, __props__=None);
func NewRoleMapper(ctx *Context, name string, args RoleMapperArgs, opts ...ResourceOption) (*RoleMapper, error)
public RoleMapper(string name, RoleMapperArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args RoleMapperArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args RoleMapperArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args RoleMapperArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

RoleMapper Resource Properties

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

Inputs

The RoleMapper resource accepts the following input properties:

LdapRolesDn string
LdapUserFederationId string

The ldap user federation provider to attach this mapper to.

MembershipLdapAttribute string
MembershipUserLdapAttribute string
RealmId string

The realm in which the ldap user federation provider exists.

RoleNameLdapAttribute string
RoleObjectClasses List<string>
ClientId string
MemberofLdapAttribute string
MembershipAttributeType string
Mode string
Name string

Display name of the mapper when displayed in the console.

RolesLdapFilter string
UseRealmRolesMapping bool
UserRolesRetrieveStrategy string
LdapRolesDn string
LdapUserFederationId string

The ldap user federation provider to attach this mapper to.

MembershipLdapAttribute string
MembershipUserLdapAttribute string
RealmId string

The realm in which the ldap user federation provider exists.

RoleNameLdapAttribute string
RoleObjectClasses []string
ClientId string
MemberofLdapAttribute string
MembershipAttributeType string
Mode string
Name string

Display name of the mapper when displayed in the console.

RolesLdapFilter string
UseRealmRolesMapping bool
UserRolesRetrieveStrategy string
ldapRolesDn string
ldapUserFederationId string

The ldap user federation provider to attach this mapper to.

membershipLdapAttribute string
membershipUserLdapAttribute string
realmId string

The realm in which the ldap user federation provider exists.

roleNameLdapAttribute string
roleObjectClasses string[]
clientId string
memberofLdapAttribute string
membershipAttributeType string
mode string
name string

Display name of the mapper when displayed in the console.

rolesLdapFilter string
useRealmRolesMapping boolean
userRolesRetrieveStrategy string
ldap_roles_dn str
ldap_user_federation_id str

The ldap user federation provider to attach this mapper to.

membership_ldap_attribute str
membership_user_ldap_attribute str
realm_id str

The realm in which the ldap user federation provider exists.

role_name_ldap_attribute str
role_object_classes List[str]
client_id str
memberof_ldap_attribute str
membership_attribute_type str
mode str
name str

Display name of the mapper when displayed in the console.

roles_ldap_filter str
use_realm_roles_mapping bool
user_roles_retrieve_strategy str

Outputs

All input properties are implicitly available as output properties. Additionally, the RoleMapper 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 RoleMapper Resource

Get an existing RoleMapper 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?: RoleMapperState, opts?: CustomResourceOptions): RoleMapper
static get(resource_name, id, opts=None, client_id=None, ldap_roles_dn=None, ldap_user_federation_id=None, memberof_ldap_attribute=None, membership_attribute_type=None, membership_ldap_attribute=None, membership_user_ldap_attribute=None, mode=None, name=None, realm_id=None, role_name_ldap_attribute=None, role_object_classes=None, roles_ldap_filter=None, use_realm_roles_mapping=None, user_roles_retrieve_strategy=None, __props__=None);
func GetRoleMapper(ctx *Context, name string, id IDInput, state *RoleMapperState, opts ...ResourceOption) (*RoleMapper, error)
public static RoleMapper Get(string name, Input<string> id, RoleMapperState? 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:

ClientId string
LdapRolesDn string
LdapUserFederationId string

The ldap user federation provider to attach this mapper to.

MemberofLdapAttribute string
MembershipAttributeType string
MembershipLdapAttribute string
MembershipUserLdapAttribute string
Mode string
Name string

Display name of the mapper when displayed in the console.

RealmId string

The realm in which the ldap user federation provider exists.

RoleNameLdapAttribute string
RoleObjectClasses List<string>
RolesLdapFilter string
UseRealmRolesMapping bool
UserRolesRetrieveStrategy string
ClientId string
LdapRolesDn string
LdapUserFederationId string

The ldap user federation provider to attach this mapper to.

MemberofLdapAttribute string
MembershipAttributeType string
MembershipLdapAttribute string
MembershipUserLdapAttribute string
Mode string
Name string

Display name of the mapper when displayed in the console.

RealmId string

The realm in which the ldap user federation provider exists.

RoleNameLdapAttribute string
RoleObjectClasses []string
RolesLdapFilter string
UseRealmRolesMapping bool
UserRolesRetrieveStrategy string
clientId string
ldapRolesDn string
ldapUserFederationId string

The ldap user federation provider to attach this mapper to.

memberofLdapAttribute string
membershipAttributeType string
membershipLdapAttribute string
membershipUserLdapAttribute string
mode string
name string

Display name of the mapper when displayed in the console.

realmId string

The realm in which the ldap user federation provider exists.

roleNameLdapAttribute string
roleObjectClasses string[]
rolesLdapFilter string
useRealmRolesMapping boolean
userRolesRetrieveStrategy string
client_id str
ldap_roles_dn str
ldap_user_federation_id str

The ldap user federation provider to attach this mapper to.

memberof_ldap_attribute str
membership_attribute_type str
membership_ldap_attribute str
membership_user_ldap_attribute str
mode str
name str

Display name of the mapper when displayed in the console.

realm_id str

The realm in which the ldap user federation provider exists.

role_name_ldap_attribute str
role_object_classes List[str]
roles_ldap_filter str
use_realm_roles_mapping bool
user_roles_retrieve_strategy str

Package Details

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