Repository navigation
fix(guides): correct the Account Lockout samples and move the Entra SCIM calls to API v4 - #2657
Merged
Merged
Conversation
…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]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
GETsample now returns the defaults the page documents (3attempts,1440minutes) instead of1and0. ThePUTsample sets5attempts and60minutes instead of a 0-minute lock, and its body is indented with spaces instead of tabs. The response keepsstateanddata, which match thePUTresponse model of the v4 SDK.?locked=trueURL is quoted so zsh does not expand it.countmatches the single entry the sample lists. TheDELETEsends no body, so itsContent-Typeheader is gone, and its response key isstate, like every other v4 response on these pages.locked_atandunlock_atare ISO 8601 (2024-01-01T10:20:01Z) instead of20240101T10:20:01.countmatches the single entry the sample lists, like the unlock guide.meta_tagsin English, as the style guide asks for pt-br pages.Microsoft Entra SCIM provisioning
https://api.azion.com/v4/iam/identity_providersand.../saml2/<uuid>. The earlierapi.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 theVersionRollingOutnotice that links to the v3 page, and the v3 page opens with theVersionDeprecatednotice that links back. The v3 page is a hidden row in the guides nav, like the other-v3guides.PATCHsendsContent-Type: application/jsonwith its JSON body.login_urlform in all three, the exampleuuidin place of<idp_uuid>inside the URLs, andlogin.microsoftonline.cominstead oflogin.microsoftonline.[Token value]becomes[TOKEN VALUE], the placeholder in the style guide.meta_tagsin English, copied from the en pair.How I checked it
pnpm lint:codeblockson the ten changed pages: no issues.pnpm lint:navcheckpasses.pnpm lint:slugcheckreports only the three single-language legal pages that main reports too.pnpm lint:linksis 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.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.--checkon the changed files passes.pnpm build:localbuilt 2168 pages, andtest-frontmatter.jspassed. Indist, the v4 Entra page shows the Rolling out notice and theapi.azion.com/v4/iamcalls, and both v3 pages show the Deprecated / Obsoleto notice and theapi.azionapi.net/iamcalls.What I could not verify. An SME should confirm before merge:
iam/identity_providers. Without a token,api.azion.com/v4/iam/identity_providersand.../saml2/<id>return 401 with the v4 error envelope, while/v4/iam/nonexistentreturns 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.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.versionRollingOut/versionDeprecatedsnippets tell readers to check whether the Console menu lists Workloads. Confirm that this criterion also decides which IAM API an account uses.GETon the list endpoint shows a single object, not a collection. This PR leaves that shape alone.Type of change
feat)fix) — typo, broken link, wrong informationdocs) — rewrite, expansion, upkeepi18n)refactor/chore) — reviewed by UXE, no content mixed inAuthor checklist
type(scope): summary(see GOVERNANCE.md §4)title,description,meta_tags,namespace,permalink,last_reviewed— every changed and new page has every key butlast_reviewed, which no page in the repo carries yetpt-brupdated in this PR or follow-upi18nissue created: — pt-br updated in this PR, with the same change on each twin and the new v3 page in both languagespnpm build:local(build + frontmatter check) without errors