Uploaded image for project: 'Identity'
  1. Identity
  2. ID-7278

Missing information about mfa.read and mfa.unenroll parameters in the 'GET User Management Permissions' REST API endpoint documentation

    XMLWordPrintable

Details

    Description

      Issue Summary

      The Get user management permissions documentation page is missing information about mfa.read and mfa.unenroll query parameters:

      QUERY PARAMETERS

      privileges

      Array<string>

      Valid values: profileprofile.writeprofile.reademail.setemail.initiateChange - lifecycle.enablementlinkedAccounts.readapiToken.readapiToken.deleteavatarprivacy.set

       

      However, the same parameters are mentioned in the "Responses" section:

      email.set: set a new value for the user's email address - email.initiateChange: initiate an email address change - mfa.read: read the current MFA enrollment state for the user - mfa.unenroll: unenroll the user from MFA ......

       

      The parameter is there and it is working fine, it should therefore be added to the list of the valid values:
      curl -H 'Authorization: Bearer <API_KEY>' -H 'Accept: application/json' -X GET https://api.atlassian.com/users/<ACCOUNT_ID>/manage?privileges=mfa.read

       
      {"mfa.read":{"allowed":true}}
       

      Attachments

        Issue Links

          Activity

            People

              jryden Joel Ryden
              dbonotto Dario B
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: