# Authentik Property Mappings API

**Canonical:** https://apis.io/apis/authentik/authentik-propertymappings-api/  
**Provider:** Authentik — https://apis.io/providers/authentik/  
**Base URL:** https://{authentik_host}/api/v3  
**Documentation:** https://api.goauthentik.io/

Authentik Property Mappings API is one of 27 APIs that [Authentik](https://apis.io/providers/authentik/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include propertymappings. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a GitHub repository.

Property mappings — the expressions that shape claims, attributes and payloads for every provider and source type, plus notification webhook bodies.

## Operations (60 of 111)

| Method | Path | Summary |
|---|---|---|
| GET | `/propertymappings/all/` | — |
| GET | `/propertymappings/all/{pm_uuid}/` | — |
| DELETE | `/propertymappings/all/{pm_uuid}/` | — |
| POST | `/propertymappings/all/{pm_uuid}/test/` | — |
| GET | `/propertymappings/all/{pm_uuid}/used_by/` | — |
| GET | `/propertymappings/all/types/` | — |
| GET | `/propertymappings/notification/` | — |
| POST | `/propertymappings/notification/` | — |
| GET | `/propertymappings/notification/{pm_uuid}/` | — |
| PUT | `/propertymappings/notification/{pm_uuid}/` | — |
| PATCH | `/propertymappings/notification/{pm_uuid}/` | — |
| DELETE | `/propertymappings/notification/{pm_uuid}/` | — |
| GET | `/propertymappings/notification/{pm_uuid}/used_by/` | — |
| GET | `/propertymappings/provider/google_workspace/` | — |
| POST | `/propertymappings/provider/google_workspace/` | — |
| GET | `/propertymappings/provider/google_workspace/{pm_uuid}/` | — |
| PUT | `/propertymappings/provider/google_workspace/{pm_uuid}/` | — |
| PATCH | `/propertymappings/provider/google_workspace/{pm_uuid}/` | — |
| DELETE | `/propertymappings/provider/google_workspace/{pm_uuid}/` | — |
| GET | `/propertymappings/provider/google_workspace/{pm_uuid}/used_by/` | — |
| GET | `/propertymappings/provider/microsoft_entra/` | — |
| POST | `/propertymappings/provider/microsoft_entra/` | — |
| GET | `/propertymappings/provider/microsoft_entra/{pm_uuid}/` | — |
| PUT | `/propertymappings/provider/microsoft_entra/{pm_uuid}/` | — |
| PATCH | `/propertymappings/provider/microsoft_entra/{pm_uuid}/` | — |
| DELETE | `/propertymappings/provider/microsoft_entra/{pm_uuid}/` | — |
| GET | `/propertymappings/provider/microsoft_entra/{pm_uuid}/used_by/` | — |
| GET | `/propertymappings/provider/rac/` | — |
| POST | `/propertymappings/provider/rac/` | — |
| GET | `/propertymappings/provider/rac/{pm_uuid}/` | — |
| PUT | `/propertymappings/provider/rac/{pm_uuid}/` | — |
| PATCH | `/propertymappings/provider/rac/{pm_uuid}/` | — |
| DELETE | `/propertymappings/provider/rac/{pm_uuid}/` | — |
| GET | `/propertymappings/provider/rac/{pm_uuid}/used_by/` | — |
| GET | `/propertymappings/provider/radius/` | — |
| POST | `/propertymappings/provider/radius/` | — |
| GET | `/propertymappings/provider/radius/{pm_uuid}/` | — |
| PUT | `/propertymappings/provider/radius/{pm_uuid}/` | — |
| PATCH | `/propertymappings/provider/radius/{pm_uuid}/` | — |
| DELETE | `/propertymappings/provider/radius/{pm_uuid}/` | — |
| GET | `/propertymappings/provider/radius/{pm_uuid}/used_by/` | — |
| GET | `/propertymappings/provider/saml/` | — |
| POST | `/propertymappings/provider/saml/` | — |
| GET | `/propertymappings/provider/saml/{pm_uuid}/` | — |
| PUT | `/propertymappings/provider/saml/{pm_uuid}/` | — |
| PATCH | `/propertymappings/provider/saml/{pm_uuid}/` | — |
| DELETE | `/propertymappings/provider/saml/{pm_uuid}/` | — |
| GET | `/propertymappings/provider/saml/{pm_uuid}/used_by/` | — |
| GET | `/propertymappings/provider/scim/` | — |
| POST | `/propertymappings/provider/scim/` | — |
| GET | `/propertymappings/provider/scim/{pm_uuid}/` | — |
| PUT | `/propertymappings/provider/scim/{pm_uuid}/` | — |
| PATCH | `/propertymappings/provider/scim/{pm_uuid}/` | — |
| DELETE | `/propertymappings/provider/scim/{pm_uuid}/` | — |
| GET | `/propertymappings/provider/scim/{pm_uuid}/used_by/` | — |
| GET | `/propertymappings/provider/scope/` | — |
| POST | `/propertymappings/provider/scope/` | — |
| GET | `/propertymappings/provider/scope/{pm_uuid}/` | — |
| PUT | `/propertymappings/provider/scope/{pm_uuid}/` | — |
| PATCH | `/propertymappings/provider/scope/{pm_uuid}/` | — |

…and 51 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/authentik/refs/heads/main/openapi/authentik-propertymappings-api-openapi.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/authentik/refs/heads/main/overlays/authentik-propertymappings-api-overlay.yaml
- **Documentation** — https://docs.goauthentik.io
- **APIReference** — https://api.goauthentik.io/
- **SDKs** — https://www.npmjs.com/package/@goauthentik/api
- **SDKs** — https://pypi.org/project/authentik-client/
- **GitHubRepository** — https://github.com/goauthentik/authentik

## Other Authentik APIs (12)

- [Authentik Core API](https://apis.io/apis/authentik/authentik-core-api/)
- [Authentik Crypto API](https://apis.io/apis/authentik/authentik-crypto-api/)
- [Authentik Events API](https://apis.io/apis/authentik/authentik-events-api/)
- [Authentik Flows API](https://apis.io/apis/authentik/authentik-flows-api/)
- [Authentik Policies API](https://apis.io/apis/authentik/authentik-policies-api/)
- [Authentik Providers API](https://apis.io/apis/authentik/authentik-providers-api/)
- [Authentik RBAC API](https://apis.io/apis/authentik/authentik-rbac-api/)
- [Authentik Schema API](https://apis.io/apis/authentik/authentik-schema-api/)
- [Authentik Sources API](https://apis.io/apis/authentik/authentik-sources-api/)
- [Authentik Stages API](https://apis.io/apis/authentik/authentik-stages-api/)
- [Authentik Admin API](https://apis.io/apis/authentik/authentik-admin-api/)
- [Authentik Agents API](https://apis.io/apis/authentik/authentik-agents-api/)

## Tags

propertymappings

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/authentik/authentik-propertymappings-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/authentik/.
