Uploaded image for project: 'Admin Experience'
  1. Admin Experience
  2. AX-210

Endpoint "Search for users within an organization" returns intermittent 504 gateway timeout

XMLWordPrintable

    • Severity 3 - Minor

      Issue Summary

      When using the new experimental endpoint Search for users within an organization that was released for the Organizations REST API, frequent timeouts can occur.

      Steps to Reproduce

      Send a POST with a JSON payload that combines the emailUsernames and emailDomains parameters to search for a user from a specific domain: 

      {
    "emailUsernames": {
        "eq": ["john.doe"]
    },
    "emailDomains": {
        "eq": [
            "mydomain.com"
        ]
    },
    "expand": ["NAME", "EMAIL"],
    "limit": 20
}

      Expected Results

      The user should be returned without any issues. 

      Actual Results

      While the query usually works, very frequently a 504 gateway timeout occurs after 15 seconds. 

      The issue happens more frequently when using "eq". When using "contains", the timeouts are not that frequent but they do take some time (around 9s) to be processed, depending on the amount of users in the user base. 

      Workaround

      Please retry the API call or implement a retry mechanism to handle the timeout if you are calling this endpoint from a script. 

            [AX-210] Endpoint "Search for users within an organization" returns intermittent 504 gateway timeout

            Rodrigo B. made changes -
            Component/s Original: User Management Public APIs [ 56701 ]
            Component/s New: Directory - User Management REST API [ 80166 ]
            Key Original: ID-8573 New: AX-210
            Preventable by Original: Soaking,Pre-deployment testing [ 19132, 19131 ]
            Support reference count Original: 5
            Symptom Severity Original: Minor [ 16130 ] New: Severity 3 - Minor [ 14432 ]
            Was this caused by a recent change? Original: No [ 19032 ]
            Project Original: Identity [ 16810 ] New: Admin Experience [ 24210 ]
            SET Analytics Bot made changes -
            Support reference count Original: 4 New: 5
            SET Analytics Bot made changes -
            Support reference count Original: 3 New: 4
            Jimmy Bell made changes -
            Remote Link New: This issue links to "Page (Confluence)" [ 947897 ]
            Jimmy Bell made changes -
            Remote Link New: This issue links to "Page (Confluence)" [ 947484 ]
            SET Analytics Bot made changes -
            Support reference count Original: 2 New: 3
            Cole Norman made changes -
            Labels New: guard-s7
            xiaji (Inactive) made changes -
            Development Effort New: S [ 13031 ]
            Preventable by New: Pre-deployment testing,Soaking [ 19131, 19132 ]
            Was this caused by a recent change? New: No [ 19032 ]
            Status Original: Needs Triage [ 10030 ] New: Short Term Backlog [ 12074 ]
            xiaji (Inactive) made changes -
            Assignee New: xiaji [ e5fdffa058ad ]
            Bugfix Automation Bot made changes -
            Priority Original: Low [ 4 ] New: Medium [ 3 ]

              e5fdffa058ad xiaji (Inactive)
              bd4a89fcb3fe Renan Andrade
              Affected customers:
              0 This affects my team
              Watchers:
              5 Start watching this issue

                Created:
                Updated: