Skip to content

Add API SAML identifier update option for domain change

Cynthia "Arty" Ng requested to merge docs-arty-domain-change into master

What does this MR do?

Unlinking and relinking an account can be very disruptive, so the recommended method of updating the identifier is to use the API.

If the identifier is not changing, there's no reason to go through the process, so it's only required if the email domain is in the NameID/identifier.

Related issues

Numerous support engineers have asked about this recently, including in relation to these tickets (internal):

  1. https://gitlab.zendesk.com/agent/tickets/373448
  2. https://gitlab.zendesk.com/agent/tickets/345353

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.

Merge request reports

Loading