[ID-8574] Include the Site URL when calling the endpoint "Search for users within an organization"

Type: Suggestion
Resolution: Unresolved
Component/s: User Management Public APIs
Labels:
- guard-s7

Support reference count:
1
Feedback Policy:

Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

When using the new experimental endpoint Search for users within an organization that was released for the Organizations REST API and expanding the PRODUCT_LAST_ACCESS field, the returned information contains only the site cloudSiteId information.

Example POST:

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

Response:

"productLastAccess": [
                {
                    "productKey": "confluence.ondemand",
                    "lastActiveTimestamp": "2023-11-09T14:44:29.857268146Z",
                    "cloudSiteId": "<YOUR_SITE_ID>"
                },
...

Suggestion:

It would be interesting to have the Site URL included in the response.

While the Site URL is not available, it's possible to use the endpoint Get list of workspaces to return a list of all the sites registered under the Atlassian Organization.

The cloudSiteId returned by PRODUCT_LAST_ACCESS can then be matched with the ID stored in the "id" attribute:

{
    "data": [
        {
            "id": "ari:cloud:jira-admin::site/<YOUR_SITE_ID>",
            "type": "workspaces",
          ...

The site URL will then be found in "hostUrl":

"hostUrl": "https://<YOUR_SITE_URL>",

Cole Norman made changes - 22/Aug/2024 5:24 AM

Labels

New: guard-s7

SET Analytics Bot made changes - 12/Apr/2024 4:02 AM

Support reference count

New: 1

Renan Andrade made changes - 11/Apr/2024 11:58 AM

Description

Original: When using the new _experimental_ endpoint [Search for users within an organization|https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v1-orgs-orgid-users-search-post] that was released for the _Organizations REST API_ and expanding the PRODUCT_LAST_ACCESS field, the returned information contains only the site cloudSiteId information.

Example POST:
{code:java}
{
    "emailUsernames": {
        "contains": "john.doe"
    },
    "emailDomains": {
        "eq": [
            "yourdomain.com"
        ]
    },
    "expand": ["NAME", "EMAIL", "PRODUCT_LAST_ACCESS"],
    "limit": 20
}
{code}

Response:
{code:java}
"productLastAccess": [
                {
                    "productKey": "confluence.ondemand",
                    "lastActiveTimestamp": "2023-11-09T14:44:29.857268146Z",
                    "cloudSiteId": "<YOUR_SITE_ID>"
                },
...{code}

*Suggestion:*

It would be interesting to have the Site URL included in the response.

While the Site URL is not available, it's possible to use the endpoint [Get list of workspaces|https://developer.atlassian.com/cloud/admin/organization/rest/api-group-workspaces/#api-v2-orgs-orgid-workspaces-post] to return a list of all the sites registered under the Atlassian Organiazation.

The _cloudSiteId_ returned by _PRODUCT_LAST_ACCESS_ can then be matched with the ID stored in the "{_}id{_}" attribute:
{code:java}
{
    "data": [
        {
            "id": "ari:cloud:jira-admin::site/<YOUR_SITE_ID>",
            "type": "workspaces",
          ...
{code}
The site URL will then be found in "hostUrl":
{code:java}
"hostUrl": "https://<YOUR_SITE_URL>", {code}

New: When using the new _experimental_ endpoint [Search for users within an organization|https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v1-orgs-orgid-users-search-post] that was released for the _Organizations REST API_ and expanding the PRODUCT_LAST_ACCESS field, the returned information contains only the site cloudSiteId information.

Example POST:
{code:java}
{
    "emailUsernames": {
        "contains": "john.doe"
    },
    "emailDomains": {
        "eq": [
            "yourdomain.com"
        ]
    },
    "expand": ["NAME", "EMAIL", "PRODUCT_LAST_ACCESS"],
    "limit": 20
}
{code}

Response:
{code:java}
"productLastAccess": [
                {
                    "productKey": "confluence.ondemand",
                    "lastActiveTimestamp": "2023-11-09T14:44:29.857268146Z",
                    "cloudSiteId": "<YOUR_SITE_ID>"
                },
...{code}

*Suggestion:*

It would be interesting to have the Site URL included in the response.

While the Site URL is not available, it's possible to use the endpoint [Get list of workspaces|https://developer.atlassian.com/cloud/admin/organization/rest/api-group-workspaces/#api-v2-orgs-orgid-workspaces-post] to return a list of all the sites registered under the Atlassian Organization.

The _cloudSiteId_ returned by _PRODUCT_LAST_ACCESS_ can then be matched with the ID stored in the "{_}id{_}" attribute:
{code:java}
{
    "data": [
        {
            "id": "ari:cloud:jira-admin::site/<YOUR_SITE_ID>",
            "type": "workspaces",
          ...
{code}
The site URL will then be found in "hostUrl":
{code:java}
"hostUrl": "https://<YOUR_SITE_URL>", {code}

Renan Andrade made changes - 11/Apr/2024 11:58 AM

Description

Original: When using the new _experimental_ endpoint [Search for users within an organization|https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v1-orgs-orgid-users-search-post] that was released for the _Organizations REST API_ and expanding the PRODUCT_LAST_ACCESS field, the returned information contains only the site cloudSiteId information.

Example:
{code:java}
{
    "emailUsernames": {
        "contains": "john.doe"
    },
    "emailDomains": {
        "eq": [
            "yourdomain.com"
        ]
    },
    "expand": ["NAME", "EMAIL", "PRODUCT_LAST_ACCESS"],
    "limit": 20
}
{code}

Return:
{code:java}
"productLastAccess": [
                {
                    "productKey": "confluence.ondemand",
                    "lastActiveTimestamp": "2023-11-09T14:44:29.857268146Z",
                    "cloudSiteId": "<YOUR_SITE_ID>"
                },
...{code}

*Suggestion:*

It would be interesting to have the Site URL included in the response.

While the Site URL is not available, it's possible to use the endpoint [Get list of workspaces|https://developer.atlassian.com/cloud/admin/organization/rest/api-group-workspaces/#api-v2-orgs-orgid-workspaces-post] to return a list of all the sites registered under the Atlassian Organiazation.

The _cloudSiteId_ returned by _PRODUCT_LAST_ACCESS_ can then be matched with the ID stored in the "{_}id{_}" attribute:
{code:java}
{
    "data": [
        {
            "id": "ari:cloud:jira-admin::site/<YOUR_SITE_ID>",
            "type": "workspaces",
          ...
{code}
The site URL will then be found in "hostUrl":
{code:java}
"hostUrl": "https://<YOUR_SITE_URL>", {code}

New: When using the new _experimental_ endpoint [Search for users within an organization|https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v1-orgs-orgid-users-search-post] that was released for the _Organizations REST API_ and expanding the PRODUCT_LAST_ACCESS field, the returned information contains only the site cloudSiteId information.

Example POST:
{code:java}
{
    "emailUsernames": {
        "contains": "john.doe"
    },
    "emailDomains": {
        "eq": [
            "yourdomain.com"
        ]
    },
    "expand": ["NAME", "EMAIL", "PRODUCT_LAST_ACCESS"],
    "limit": 20
}
{code}

Response:
{code:java}
"productLastAccess": [
                {
                    "productKey": "confluence.ondemand",
                    "lastActiveTimestamp": "2023-11-09T14:44:29.857268146Z",
                    "cloudSiteId": "<YOUR_SITE_ID>"
                },
...{code}

*Suggestion:*

It would be interesting to have the Site URL included in the response.

While the Site URL is not available, it's possible to use the endpoint [Get list of workspaces|https://developer.atlassian.com/cloud/admin/organization/rest/api-group-workspaces/#api-v2-orgs-orgid-workspaces-post] to return a list of all the sites registered under the Atlassian Organiazation.

The _cloudSiteId_ returned by _PRODUCT_LAST_ACCESS_ can then be matched with the ID stored in the "{_}id{_}" attribute:
{code:java}
{
    "data": [
        {
            "id": "ari:cloud:jira-admin::site/<YOUR_SITE_ID>",
            "type": "workspaces",
          ...
{code}
The site URL will then be found in "hostUrl":
{code:java}
"hostUrl": "https://<YOUR_SITE_URL>", {code}

Renan Andrade created issue - 11/Apr/2024 11:57 AM

Details

Description

Attachments

Forms

Activity

People

Dates