authentik/docs/property-mappings/index.md

# Property Mappings

Property Mappings allow you to pass information to external applications. For example, pass the current user's groups as a SAML parameter. Property Mappings are also used to map Source fields to passbook fields, for example when using LDAP.

## SAML Property Mapping

SAML Property Mappings allow you embed information into the SAML AuthN request. This information can then be used by the application to, for example, assign permissions to the object.

You can find examples [here](integrations/).

## LDAP Property Mapping

LDAP Property Mappings are used when you define a LDAP Source. These mappings define which LDAP property maps to which passbook property. By default, the following mappings are created:

- Autogenerated LDAP Mapping: givenName -> first_name
- Autogenerated LDAP Mapping: mail -> email
- Autogenerated LDAP Mapping: name -> name
- Autogenerated LDAP Mapping: sAMAccountName -> username
- Autogenerated LDAP Mapping: sn -> last_name

These are configured with most common LDAP setups.

## Scope Mapping

Scope Mappings are used by the OAuth2 Provider to map information from passbook to OAuth2/OpenID Claims.
docs: add docs for property mappings, switch to material theme 2019-12-10 10:25:34 +00:00			`# Property Mappings`

docs(index.md): capitalisation and clarity 2020-06-18 18:02:58 +00:00			`Property Mappings allow you to pass information to external applications. For example, pass the current user's groups as a SAML parameter. Property Mappings are also used to map Source fields to passbook fields, for example when using LDAP.`
docs: add docs for property mappings, switch to material theme 2019-12-10 10:25:34 +00:00
			`## SAML Property Mapping`

docs(index.md): capitalisation and clarity 2020-06-18 18:02:58 +00:00			`SAML Property Mappings allow you embed information into the SAML AuthN request. This information can then be used by the application to, for example, assign permissions to the object.`
docs: add docs for property mappings, switch to material theme 2019-12-10 10:25:34 +00:00
docs(index.md): capitalisation and clarity 2020-06-18 18:02:58 +00:00			`You can find examples [here](integrations/).`
docs: add docs for property mappings, switch to material theme 2019-12-10 10:25:34 +00:00
			`## LDAP Property Mapping`

docs(index.md): capitalisation and clarity 2020-06-18 18:02:58 +00:00			`LDAP Property Mappings are used when you define a LDAP Source. These mappings define which LDAP property maps to which passbook property. By default, the following mappings are created:`
docs: add docs for property mappings, switch to material theme 2019-12-10 10:25:34 +00:00
policies/expression: migrate to raw python instead of jinja2 (#49) * policies/expression: migrate to raw python instead of jinja2 * lib/expression: create base evaluator, custom subclass for policies * core: rewrite propertymappings to use python * providers/saml: update to new PropertyMappings * sources/ldap: update to new PropertyMappings * docs: update docs for new propertymappings * root: remove jinja2 * root: re-add jinja to lock file as its implicitly required 2020-06-05 10:00:27 +00:00			`- Autogenerated LDAP Mapping: givenName -> first_name`
			`- Autogenerated LDAP Mapping: mail -> email`
			`- Autogenerated LDAP Mapping: name -> name`
			`- Autogenerated LDAP Mapping: sAMAccountName -> username`
			`- Autogenerated LDAP Mapping: sn -> last_name`
docs: add docs for property mappings, switch to material theme 2019-12-10 10:25:34 +00:00
docs(index.md): capitalisation and clarity 2020-06-18 18:02:58 +00:00			`These are configured with most common LDAP setups.`
docs: improve documentation for providers 2020-09-09 17:14:12 +00:00
			`## Scope Mapping`

			`Scope Mappings are used by the OAuth2 Provider to map information from passbook to OAuth2/OpenID Claims.`