Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

website/docs: update geoip and asn documentation following field changes (cherry-pick #10265) #10266

Merged
merged 1 commit into from
Jun 27, 2024
Merged

website/docs: update geoip and asn documentation following field changes (cherry-pick #10265) #10266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions website/docs/policies/expression.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,26 @@ import Objects from "../expressions/_objects.md";
- `request.obj`: A Django Model instance. This is only set if the policy is ran against an object.
- `request.context`: A dictionary with dynamic data. This depends on the origin of the execution.

- `geoip`: GeoIP object, see [GeoIP](https://geoip2.readthedocs.io/en/latest/#geoip2.models.City)
- `geoip`: GeoIP dictionary. The following fields are available:

- `continent`: a two character continent code like `NA` (North America) or `OC` (Oceania).
- `country`: the two character [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) alpha code for the country.
- `lat`: the approximate latitude of the location associated with the IP address.
- `long`: the approximate longitude of the location associated with the IP address.
- `city`: the name of the city. May be empty.

```python
return context["geoip"]["country"]["iso_code"] == "US"
return context["geoip"]["country"] == "US"
```

- `asn`: ASN object, see [GeoIP](https://geoip2.readthedocs.io/en/latest/#geoip2.models.ASN)
- `asn`: ASN dictionary. The follow fields are available:

- `asn`: the autonomous system number associated with the IP address.
- `as_org`: the organization associated with the registered autonomous system number for the IP address.
- `network`: the network associated with the record. In particular, this is the largest network where all of the fields except `ip_address` have the same value.

```python
return context["asn"]["autonomous_system_number"] == 64496
return context["asn"]["asn"] == 64496
```

- `ak_is_sso_flow`: Boolean which is true if request was initiated by authenticating through an external provider.
Expand Down
2 changes: 0 additions & 2 deletions website/docs/releases/2024/v2024.6.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ With this release, authentik now enforces unique group names. Existing groups wi

The `context["geoip"]` and `context["asn"]` objects available in expression policies are now dictionaries. Attributes must now be accessed via dictionary accessors. See [our policy examples](../../policies/expression.mdx) for the updated syntax.

For instance, `context["geoip"].country.iso_code` must now become `context["geoip"]["country"]["iso_code"]`.

## New features

- **Google Workspace Provider** <span class="badge badge--primary">Enterprise</span> <span class="badge badge--info">Preview</span>
Expand Down
Loading