Confluence page shared with user

The Teamwork Graph API is coming soon. The relationship types documented here are indicative of what will be available in the Graph via the Teamwork Graph API. Please note that relationships, their properties, and functionality may change before and during the Early Access Program.

Interested in early access? Express your interest in joining the EAP

The ConfluencePageSharedWithUser relationship represents the link between a Confluence page and an Identity user within the Teamwork Graph. It allows you to:

Retrieve users who have access to a specific Confluence page
Find which Confluence pages are shared with a user
Traverse and analyze page-user-sharing relationships

TTL

30 days

The TTL (Time To Live) specifies the retention period for relationship data, determining how far back in time the relationship remains queryable.

Types

From Object Types	To Object Types
`Confluence Page - ati:cloud:confluence:page`	`Identity User - ati:cloud:identity:user`

Cypher

Forward Query

GraphQL

1
2
query ConfluencePageSharedWithUser_CypherQuery($cypherQuery: String!, $params: CypherRequestParams) {
  cypherQuery(query: $cypherQuery, params: $params) {
    edges {
      node {
        columns {
          value {
            ... on CypherQueryResultNode {
              id
              data {
                __typename
                ... on AtlassianAccountUser {
                  id
                }
                ... on CustomerUser {
                  id
                }
                ... on AppUser {
                  id
                }
              }
            }
          }
        }
      }
    }
  }
}

Params

Note

We recommend sending parameterized Cypher queries as below instead of embedding the parameters directly in the query string. This approach will help ensure better performance.

1
2
{
  "cypherQuery": "MATCH (page:ConfluencePage {ari: $id})-[:confluence_page_shared_with_user]->(user:IdentityUser) RETURN user",
  "params": {
    "id": "$id"
  }
}

Inverse Query

GraphQL

1
2
query ConfluencePageSharedWithUser_CypherQuery($cypherQuery: String!, $params: CypherRequestParams) {
  cypherQuery(query: $cypherQuery, params: $params) {
    edges {
      node {
        columns {
          value {
            ... on CypherQueryResultNode {
              id
              data {
                __typename
                ... on ConfluencePage {
                  id
                }
              }
            }
          }
        }
      }
    }
  }
}

Params

Note

We recommend sending parameterized Cypher queries as below instead of embedding the parameters directly in the query string. This approach will help ensure better performance.

1
2
{
  "cypherQuery": "MATCH (page:ConfluencePage)-[:confluence_page_shared_with_user]->(user:IdentityUser {ari: $id}) RETURN page",
  "params": {
    "id": "$id"
  }
}