Organization Authorizations

  • Article

Warning

Deprecation Notice
The Marketing version 202304 (Marketing April 2023) and below has been sunset and the unversioned APIs are going to be sunset soon. We recommend that you migrate to the versioned APIs as well as migrate to the new Content and Community Management APIs to avoid disruptions. See the Migration page for more details. If you haven’t yet migrated and have questions, submit a request on the LinkedIn Developer Support Portal.

Organization Authorizations allow you to access an organization's administrative data and API on its behalf.

Note

All API request examples in this document must include a header for Restli Protocol 2.0.0 as X-Restli-Protocol-Version: 2.0.0

All URNs must be URL Encoded:
A colon should be translated to "%3A", so urn:li:organization:12345 is encoded to urn%3Ali%3Aorganization%3A12345.

Permissions

Permission Description
rw_organization_admin Manage organizations pages and retrieve reporting data.

OrganizationAuthorizationAction

AuthorizationAction Description
OrganizationRoleAuthorizationAction What type of action a user wants to take on an organization's role holders, such as adding or removing an administrator. Valid enums include:
  • ADMINISTRATOR_READ
  • ADMINISTRATOR_WRITE
  • DIRECT_SPONSORED_CONTENT_POSTER_READ
  • DIRECT_SPONSORED_CONTENT_POSTER_WRITE
  • PIPELINE_BUILDER_READ
  • PIPELINE_BUILDER_WRITE
  • PENDING_ADMIN_READ
  • PENDING_ADMIN_WRITE
  • PENDING_DIRECT_SPONSORED_CONTENT_POSTER_READ
  • PENDING_DIRECT_SPONSORED_CONTENT_POSTER_WRITE
OrganizationContentAuthorizationAction What type of action a user wants to take on an organization's content such as editing or reading. Valid enums include:
  • ORGANIC_SHARE_VIEW_AS_AUTHOR
  • ORGANIC_SHARE_CREATE
  • ORGANIC_SHARE_EDIT
  • ORGANIC_SHARE_DELETE
  • DARK_SHARE_CREATE
  • DARK_SHARE_EDIT
  • DARK_SHARE_DELETE
  • DARK_SHARE_VIEW_AS_AUTHOR
OrganizationProfileAuthorizationAction What type of action a user wants to take on an organization's profile such as creating a showcase or editing the profile. Valid enums include:
  • ADMINISTRATION_PAGE_VIEW
OrganizationActivityAuthorizationAction What type of action a user wants to take on an organization's activity monitoring page such as editing or reading. Valid enums include:
  • ORGANIZATION_ACTIVITY_READ
OrganizationAnalyticsAuthorizationAction What type of action a user wants to take on an organization's analytics page. Valid enums include:
  • VISITOR_ANALYTICS_READ
  • FOLLOWER_ANALYTICS_READ
  • UPDATE_ANALYTICS_READ
OrganizationApplicationAuthorizationAction What type of action a user wants to take on an organization's third party applications such as associating their application to a LinkedIn organization. Valid enums include:
  • APPLICATION_ASSOCIATE

Fetch Organization Authorization Information

The /organizationAuthorizations endpoint supports GET, BATCH_GET, and BATCH_FINDER authorizationActionsAndImpersonator<!----and authorizationActionsAndOrganization BatchFinder-->.

Caution

The request must include a header for Restli Protocol 2.0.0 as X-Restli-Protocol-Version: 2.0.0

Get Organization Authorization Information

You can use the personUrn, organizationUrn and OrganizationAuthorizationAction to lookup Organization Authorization information on behalf of authenticated members. API calls with insufficient permissions receive a 403 Forbidden response.

Sample Request

GET https://api.linkedin.com/rest/organizationAuthorizations/(impersonator:{PERSON_URN},organization:{ORGANIZATION_URN},action:(organizationRoleAuthorizationAction:(actionType:ADMINISTRATOR_READ)))

GET https://api.linkedin.com/v2/organizationAuthorizations/(impersonator:{PERSON_URN},organization:{ORGANIZATION_URN},action:(organizationRoleAuthorizationAction:(actionType:ADMINISTRATOR_READ)))

Sample Response

{
    "impersonator": "urn:li:person:12345678",
    "action": {
        "OrganizationRoleAuthorizationActionType": {
            "actionType": "ADMINISTRATOR_READ"
        }
    },
    "organization": "urn:li:organization:11111111",
    "status": {
        "com.linkedin.organization.Approved": {}
    }
}

Batch Get Organization Authorization Information

You can fetch a list of Organizations Authorizations for authenticated members. API calls with insufficient permissions receive a 403 Forbidden response.

Sample Request

GET https://api.linkedin.com/rest/organizationAuthorizations?ids=List((impersonator:{PERSON_URN},organization:{ORGANIZATION_URN},action:(organizationRoleAuthorizationAction:(actionType:ADMINISTRATOR_READ))),(impersonator:{PERSON_URN2},organization:{ORGANIZATION_URN2},action:(organizationRoleAuthorizationAction:(actionType:ADMINISTRATION_PAGE_VIEW))))

GET https://api.linkedin.com/v2/organizationAuthorizations?ids=List((impersonator:{PERSON_URN},organization:{ORGANIZATION_URN},action:(organizationRoleAuthorizationAction:(actionType:ADMINISTRATOR_READ))),(impersonator:{PERSON_URN2},organization:{ORGANIZATION_URN2},action:(organizationRoleAuthorizationAction:(actionType:ADMINISTRATION_PAGE_VIEW))))

Sample Response

{
    "statuses": {},
    "results": {
      "(action:(OrganizationRoleAuthorizationActionType:(actionType:ADMINISTRATOR_READ)),impersonator:urn%3Ali%3Aperson%3A12345678,organization:urn%3Ali%3Aorganization%3A11111111)": {
            "impersonator": "urn:li:person:12345678",
            "action": {
                "OrganizationRoleAuthorizationActionType": {
                    "actionType": "ADMINISTRATOR_READ"
                }
            },
            "organization": "urn:li:organization:11111111",
            "status": {
                "com.linkedin.organization.Approved": {}
            }
        },
        "(action:(OrganizationRoleAuthorizationActionType:(actionType:ADMINISTRATION_PAGE_VIEW)),impersonator:urn%3Ali%3Aperson%3A12345679,organization:urn%3Ali%3Aorganization%3A11111112)": {
            "impersonator": "urn:li:person:12345679",
            "action": {
                "OrganizationRoleAuthorizationActionType": {
                    "actionType": "ADMINISTRATION_PAGE_VIEW"
                }
            },
            "organization": "urn:li:organization:11111112",
            "status": {
                "com.linkedin.organization.Denied": {
                    "reasons": [
                        "ORGANIZATION_INACTIVE",
                        "MEMBER_HAS_INSUFFICIENT_PERMISSIONS_IN_ACCESS_CONTROL"
                    ]
                }
            }
        }
    },
    "errors": {}
}

Batch Find Organization Authorization Information by authorizationAction and Authenticated Member

You can look up Organization Authorizations using AuthorizationAction and authenticated member. The impersonator that is fetched Organization Authorizations against is always set to the authenticated member. Please refer the batch finder usage instruction in LinkedIn API Methods linkedin-api-docs/shared/api-guide/concepts/methods.md

Sample Request

GET https://api.linkedin.com/rest/organizationAuthorizations?bq=authorizationActionsAndImpersonator&authorizationActions=List((authorizationAction:(organizationAnalyticsAuthorizationAction:(actionType:VISITOR_ANALYTICS_READ))),(authorizationAction:(organizationAnalyticsAuthorizationAction:(actionType:FOLLOWER_ANALYTICS_READ))))

GET https://api.linkedin.com/v2/organizationAuthorizations?bq=authorizationActionsAndImpersonator&authorizationActions=List((authorizationAction:(organizationAnalyticsAuthorizationAction:(actionType:VISITOR_ANALYTICS_READ))),(authorizationAction:(organizationAnalyticsAuthorizationAction:(actionType:FOLLOWER_ANALYTICS_READ))))

Sample Response

{
    "elements": [
        {
            "elements": [
                {
                    "impersonator": "urn:li:person:12345678",
                    "action": {
                        "OrganizationAnalyticsAuthorizationAction": {
                            "actionType": "VISITOR_ANALYTICS_READ"
                        }
                    },
                    "organization": "urn:li:organization:11111111",
                    "status": {
                        "com.linkedin.organization.Approved": {}
                    }
                },
                {
                    "impersonator": "urn:li:person:12345678",
                    "action": {
                        "OrganizationAnalyticsAuthorizationAction": {
                            "actionType": "VISITOR_ANALYTICS_READ"
                        }
                    },
                    "organization": "urn:li:organization:11111112",
                    "status": {
                        "com.linkedin.organization.Approved": {}
                    }
                }
            ],
            "paging": {
                "count": 10,
                "start": 0,
                "links": []
            }
        },
        {
            "elements": [
                {
                    "impersonator": "urn:li:person:123345678",
                    "action": {
                        "OrganizationAnalyticsAuthorizationAction": {
                            "actionType": "FOLLOWER_ANALYTICS_READ"
                        }
                    },
                    "organization": "urn:li:organization:11111111",
                    "status": {
                        "com.linkedin.organization.Approved": {}
                    }
                },
                {
                    "impersonator": "urn:li:person:12345678",
                    "action": {
                        "OrganizationAnalyticsAuthorizationAction": {
                            "actionType": "FOLLOWER_ANALYTICS_READ"
                        }
                    },
                    "organization": "urn:li:organization:11111112",
                    "status": {
                        "com.linkedin.organization.Approved": {}
                    }
                }
            ],
            "paging": {
                "count": 10,
                "start": 0,
                "links": []
            }
        }
    ]
}