Skip to content

fix(guides): correct the Account Lockout samples and move the Entra SCIM calls to API v4 - #2657

Merged
bruno-andrade-azion merged 2 commits into
mainfrom
fix/lockout-entra-api-samples
Nov 17, 2026
Merged

bruno-andrade-azion merged 2 commits into
mainfrom
fix/lockout-entra-api-samples

Conversation

@bruno-andrade-azion

@bruno-andrade-azion bruno-andrade-azion commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

What & why

Related issue: MM-16267
Pages affected: /en/documentation/guides/application-security/access-and-compliance/configure-account-lockout-policy/, .../unlock-account-lockout-policy/, .../account-lockout-policy-logs/, .../microsoft-entra-automated-user-provisioning/, new .../microsoft-entra-automated-user-provisioning-v3/, and their pt-br twins (.../configurar-account-lockout-policy/, .../desbloquear-account-lockout-policy/, .../account-lockout-policy-logs/, .../microsoft-entra-provisionamento-automatizado-de-usuarios/, new ...-v3/)

The API samples on the Account Lockout Policy guides and the Microsoft Entra SCIM guide contradicted their own pages or did not run as pasted.

Account Lockout Policy

  • Configure: the GET sample now returns the defaults the page documents (3 attempts, 1440 minutes) instead of 1 and 0. The PUT sample sets 5 attempts and 60 minutes instead of a 0-minute lock, and its body is indented with spaces instead of tabs. The response keeps state and data, which match the PUT response model of the v4 SDK.
  • Unlock: the ?locked=true URL is quoted so zsh does not expand it. count matches the single entry the sample lists. The DELETE sends no body, so its Content-Type header is gone, and its response key is state, like every other v4 response on these pages.
  • Unlock and logs: locked_at and unlock_at are ISO 8601 (2024-01-01T10:20:01Z) instead of 20240101T10:20:01.
  • Logs: count matches the single entry the sample lists, like the unlock guide.
  • The pt-br configure guide keeps its meta_tags in English, as the style guide asks for pt-br pages.
  • The prerequisite the review flagged as circular (a 403 on an account where the policy is not active) is already fixed on main: the pages separate enabled by Azion from active. This PR does not touch it.

Microsoft Entra SCIM provisioning

  • The guide now calls https://api.azion.com/v4/iam/identity_providers and .../saml2/<uuid>. The earlier api.azionapi.net/iam/... calls move to a new page, ... | v3, which follows the v3/v4 pattern of the Applications overview. The v4 page opens with the VersionRollingOut notice that links to the v3 page, and the v3 page opens with the VersionDeprecated notice that links back. The v3 page is a hidden row in the guides nav, like the other -v3 guides.
  • The PATCH sends Content-Type: application/json with its JSON body.
  • The responses agree with each other: one login_url form in all three, the example uuid in place of <idp_uuid> inside the URLs, and login.microsoftonline.com instead of login.microsoftonline.
  • [Token value] becomes [TOKEN VALUE], the placeholder in the style guide.
  • Both pt-br Entra pages keep their meta_tags in English, copied from the en pair.

How I checked it

  • pnpm lint:codeblocks on the ten changed pages: no issues.
  • pnpm lint:navcheck passes. pnpm lint:slugcheck reports only the three single-language legal pages that main reports too.
  • pnpm lint:links is warn-only. It reports two more findings than main: the two new v3 pages inherit the "no closing link deeper into the product" warning that the v4 page already carries.
  • The docs-writer docs_gate.py --check: 0 findings on the ten pages. Its link check matches main, and the new namespace is paired en and pt-br.
  • Prettier --check on the changed files passes.
  • pnpm build:local built 2168 pages, and test-frontmatter.js passed. In dist, the v4 Entra page shows the Rolling out notice and the api.azion.com/v4/iam calls, and both v3 pages show the Deprecated / Obsoleto notice and the api.azionapi.net/iam calls.

What I could not verify. An SME should confirm before merge:

  1. The v4 IAM route. Neither the public v4 OpenAPI file nor the v3 Postman collection lists iam/identity_providers. Without a token, api.azion.com/v4/iam/identity_providers and .../saml2/<id> return 401 with the v4 error envelope, while /v4/iam/nonexistent returns 404. The v3 host returns the same v4 envelope on that route. The response bodies on the v4 page are the earlier ones, made consistent, and were not checked against an authenticated call.
  2. The unlock endpoint in production. The v4 SDK lists DELETE /identity/users/{user_id}/lockout, with an empty response body, against the stage host. In production, that path returns 404 without a token, while /identity/users/{id} returns 401. The path is unchanged here.
  3. The version notices. The versionRollingOut/versionDeprecated snippets tell readers to check whether the Console menu lists Workloads. Confirm that this criterion also decides which IAM API an account uses.
  4. The identity providers list. The GET on the list endpoint shows a single object, not a collection. This PR leaves that shape alone.

Type of change

  • 🆕 New content (feat)
  • 🩹 Fix (fix) — typo, broken link, wrong information
  • ♻️ Content update (docs) — rewrite, expansion, upkeep
  • 🌐 Translation sync (i18n)
  • 🏗️ Platform / structure (refactor / chore) — reviewed by UXE, no content mixed in

Author checklist

  • PR title follows type(scope): summary (see GOVERNANCE.md §4)
  • Frontmatter complete: title, description, meta_tags, namespace, permalink, last_reviewed — every changed and new page has every key but last_reviewed, which no page in the repo carries yet
  • No legacy "edge-" product names in the copy — no text with a product name is added
  • How-to/tutorial content includes at least one runnable, copy-paste-tested code block — not tested against an account: the requests need an Account Owner token and an account with the policy and SSO enabled; the blocks pass the code-block lint
  • Screenshots (if any) have alt text and follow image standards — no screenshot is added or changed
  • Internal links are relative and resolve locally
  • If any permalink changed or page moved: redirect added in this PR — no permalink changed and no page moved; the v3 pages are new
  • i18n: pt-br updated in this PR or follow-up i18n issue created: — pt-br updated in this PR, with the same change on each twin and the new v3 page in both languages
  • I ran pnpm build:local (build + frontmatter check) without errors

…CIM calls to API v4

Account Lockout Policy: the GET sample shows the documented defaults, the
PUT sets a real lock, the locked-users URL is quoted, timestamps are ISO
8601, and the unlock response uses state. Microsoft Entra SCIM: the guide
calls the v4 IAM host, the PATCH sends Content-Type, the responses agree,
and the v3 calls move to a new -v3 page with the version notices.

Co-Authored-By: Claude <[email protected]>
…e count

The pt-br Entra pages and the pt-br configure guide carried Portuguese
terms in meta_tags; the style guide keeps them in English, as on the en
pair. The logs sample now counts the one entry it lists, like the unlock
guide.

Co-Authored-By: Claude <[email protected]>
@bruno-andrade-azion
bruno-andrade-azion merged commit fe8c834 into main Nov 17, 2026
10 checks passed
@bruno-andrade-azion
bruno-andrade-azion deleted the fix/lockout-entra-api-samples branch November 17, 2026 23:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants