Organization Access Control

A role defines the privileges that a member has within the organization. You must be an authenticated member with role type ADMINISTRATOR for an organization to use many of the Organization APIs.

You can search for access control information by member or organizational entity URNs.

Permissions

Permission Description
rw_organization_admin Manage organizations pages and retrieve reporting data. Restricted to organizations in which the authenticated member has the following role:
  • ADMINISTRATOR

If you are using legacy permissions, please refer to this page for requesting legacy permissions.

Organization Roles

Role Type Description
ADMINISTRATOR Access to administer an organizational entity. An administrator can post updates, edit the organization's page, add other admins, view analytics, and view notifications.
DIRECT_SPONSORED_CONTENT_POSTER Access to read and create direct sponsored content for an organizational entity.
RECRUITING_POSTER Access to post to an organizational entity.
LEAD_CAPTURE_ADMINISTRATOR Access to view and manage landing pages for the company, as well as create new landing pages or edit existing ones.
LEAD_GEN_FORMS_MANAGER Access to retrieve leads that belong to a specific account which is associated with a company page.

Find Access Control Information

A new endpoint /organizationAcls is now available supporting the PUT, roleAssignee FINDER, and organization FINDER methods.

Because the /organizationAcls endpoint is replacing /organizationEntityAcls, the existing endpoint for this feature, LinkedIn recommends that you use the new endpoint. You must be an administrator to perform any of these requests.

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

Find a Member's Organization Access Control Information

Sample Request

GET https://api.linkedin.com/v2/organizationAcls?q=roleAssignee

Parameters

Field Description Format Required
role Limit results to specific roles, such as ADMINISTRATOR or DIRECT_SPONSORED_CONTENT_POSTER string No
state Limit results to specific role states, such as APPROVED or REQUESTED. string No

Sample Response

{
    "elements": [
        {
            "role": "DIRECT_SPONSORED_CONTENT_POSTER",
            "organization": "urn:li:organization:1234123",
            "roleAssignee": "urn:li:person:abCdEf",
            "state": "REQUESTED"
        }
    ],
    "paging": {
        "count": 10,
        "start": 0,
        "links": []
    }
}

Find Organization Administrators

Sample Request

GET https://api.linkedin.com/v2/organizationAcls?q=organization&organization={encoded organization URN}&role=ADMINISTRATOR&state=APPROVED

A successful response returns a 200 OK HTTP status code.

A failed response returns one of the following status codes:

Code Description
401 Malformed requests. Typically, the Access Control fields are invalid.
403 A viewer is not present, or the user is not authorized to modify the Access Control.
404 The Access Control does not exist.

Sample Response

{ "elements": [ { "role": "ADMINISTRATOR", "organization": "urn:li:organization:1000", "roleAssignee": "urn:li:person:abCdEf", "state": "APPROVED" } ], "paging": { "count": 10, "start": 0, "links": [] } }

Find Organization Access Control

Sample Request

GET https://api.linkedin.com/v2/organizationAcls?q=organization&organization={encoded organization URN}

Sample Response

{
  "paging": {
    "count": 10,
    "start": 0
  },
  "elements": [
    {
      "state": "APPROVED",
      "role": "ADMINISTRATOR",
      "roleAssignee": "urn:li:person:A839rocZ",
      "organizationTarget": "urn:li:organization:1000"
    },
    {
      "state": "APPROVED",
      "role": "ADMINISTRATOR",
      "roleAssignee": "urn:li:person:pwo82E2v",
      "organizationTarget": "urn:li:organization:1000"
    },
    {
      "state": "APPROVED",
      "role": "ADMINISTRATOR",
      "roleAssignee": "urn:li:person:vQpe2J8",
      "organizationTarget": "urn:li:organization:1000"
    },
    {
      "state": "APPROVED",
      "role": "ADMINISTRATOR",
      "roleAssignee": "urn:li:person:J2foLx4",
      "organizationTarget": "urn:li:organization:1000"
    }
  ]
}

Parameters

Field Description Format Required
role Limit results to specific roles, such as ADMINISTRATOR or DIRECT_SPONSORED_CONTENT_POSTER string No
state Limit results to specific role states, such as APPROVED or REQUESTED. string No

Using Projections

Use projections to get more information, such as the member's first and last name or the organization name. See here for more information on how projections work.

Sample Request

GET https://api.linkedin.com/v2/organizationAcls?q=roleAssignee&role=ADMINISTRATOR&projection=(elements*(*,roleAssignee~(localizedFirstName, localizedLastName), organization~(localizedName)))

Sample Response

{
  "elements": [
    {
      "organization~": {
        "localizedName": "TestCompany"
      },
      "role": "ADMINISTRATOR",
      "roleAssignee": "urn:li:person:pE3vIq7yK6",
      "state": "APPROVED",
      "roleAssignee~": {
        "localizedLastName": "Smith",
        "localizedFirstName": "John"
      },
      "organization": "urn:li:organization:18062654"
    }
    {
      "organization~": {
        "localizedName": "TestCompanyShowcase"
      },
      "role": "ADMINISTRATOR",
      "roleAssignee": "urn:li:person:pE3vIq7yK6",
      "state": "APPROVED",
      "roleAssignee~": {
        "localizedLastName": "Smith",
        "localizedFirstName": "John"
      },
      "organization": "urn:li:organizationBrand:18085185"
    },
    {
      "organization~": {
        "localizedName": "DevTestCo \"Quote\""
      },
      "role": "ADMINISTRATOR",
      "roleAssignee": "urn:li:person:pE3vIq7yK6",
      "state": "APPROVED",
      "roleAssignee~": {
        "localizedLastName": "Smith",
        "localizedFirstName": "John"
      },
      "organization": "urn:li:organization:2414183"
    }
  ]
}

Request Direct Sponsored Content Poster Role

Request DIRECT_SPONSORED_CONTENT_POSTER role to an organization

Sample Request

GET https://api.linkedin.com/v2/organizationAcls/(organization:{encoded organization URN},role:DIRECT_SPONSORED_CONTENT_POSTER,roleAssignee:{person URN})
{
    "state": "REQUESTED",
    "role": "DIRECT_SPONSORED_CONTENT_POSTER",
    "roleAssignee": "urn:li:person:abCdEf",
    "organization": "urn:li:organization:1000"
}

Request Body Fields

Field Description Format Required
role The role to add. Only the value DIRECT_SPONSORED_CONTENT_POSTER is supported. string Yes
state The role state to add. Only the value REQUESTED is supported. string Yes
roleAssignee The person URN of the member being added. Must be in the format urn:li:person{id}. string Yes
organization The organizational entity for which access control information is being added. Must either be in the format urn:li:organization:{id} or urn:li:organizationBrand:{id} string Yes

A successful response returns a 200 OK status code.

Find Access Control Information Using OrganizationalEntityAcls (DEPRECATED)

Important

The /organizationalEntityAcls endpoint has been deprecated in favor of the new /organizationAcls endpoint, and will be sunset in the future. Please do not use the below endpoint for new integrations.

You must be an ADMINISTRATOR to perform many of these requests.

Find a Member's Organization Access Control Information (DEPRECATED)

Sample Request

GET https://api.linkedin.com/v2/organizationalEntityAcls?q=roleAssignee

Parameters

Field Description Format Required
role Limit results to specific roles, such as ADMINISTRATOR. string No
state Limit results to specific role states, such as APPROVED. string No

Sample Response

{
  "paging": {
    "count": 10,
    "start": 0
  },
  "elements": [
    {
      "state": "APPROVED",
      "role": "ADMINISTRATOR",
      "roleAssignee": "urn:li:person:R8302pZx",
      "organizationalTarget": "urn:li:organization:1000"
    }
  ]
}

Find Organization Administrators (DEPRECATED)

Find all members who have elevated access for a given organizational entity using either an organization URN or organizationBrand URN.

Sample Request

GET https://api.linkedin.com/v2/organizationalEntityAcls?q=organizationalTarget&organizationalTarget={organization URN}&role=ADMINISTRATOR&state=APPROVED

Find an Organization's Access Control Information (DEPRECATED)

Find all members who are in specific roles for a given organizational entity using an organization URN or organizationBrand URN.

Sample Request

GET https://api.linkedin.com/v2/organizationalEntityAcls?q=organizationalTarget&organizationalTarget={URN}

Parameters

Field Description Format Required
organizationalTarget The organizational entity for which access control information is retrieved. Must either be in the format urn:li:organization:{id} or urn:li:organizationBrand:{id} URN Yes
role Limit results to specific roles, such as ADMINISTRATOR. string No
state Limit results to specific role states such as APPROVED. string No

Sample Response

{
  "paging": {
    "count": 10,
    "start": 0
  },
  "elements": [
    {
      "state": "APPROVED",
      "role": "ADMINISTRATOR",
      "roleAssignee": "urn:li:person:A839rocZ",
      "organizationalTarget": "urn:li:organization:1000"
    },
    {
      "state": "APPROVED",
      "role": "ADMINISTRATOR",
      "roleAssignee": "urn:li:person:pwo82E2v",
      "organizationalTarget": "urn:li:organization:1000"
    },
    {
      "state": "APPROVED",
      "role": "ADMINISTRATOR",
      "roleAssignee": "urn:li:person:vQpe2J8",
      "organizationalTarget": "urn:li:organization:1000"
    },
    {
      "state": "APPROVED",
      "role": "ADMINISTRATOR",
      "roleAssignee": "urn:li:person:J2foLx4",
      "organizationalTarget": "urn:li:organization:1000"
    }
  ]
}

Using Projections (Deprecated)

Use projections to get more information, such as the member's first and last name or the organization name. See here for more information on how projections work.

Sample Request

GET https://api.linkedin.com/v2/organizationalEntityAcls?q=roleAssignee&role=ADMINISTRATOR&projection=(elements*(*,roleAssignee~(localizedFirstName, localizedLastName), organizationalTarget~(localizedName)))

Sample Response

{
  "elements": [
    {
      "organizationalTarget~": {
        "localizedName": "TestCompany"
      },
      "role": "ADMINISTRATOR",
      "roleAssignee": "urn:li:person:pE3vIq7yK6",
      "state": "APPROVED",
      "roleAssignee~": {
        "localizedLastName": "Smith",
        "localizedFirstName": "John"
      },
      "organizationalTarget": "urn:li:organization:18062654"
    }
    {
      "organizationalTarget~": {
        "localizedName": "TestCompanyShowcase"
      },
      "role": "ADMINISTRATOR",
      "roleAssignee": "urn:li:person:pE3vIq7yK6",
      "state": "APPROVED",
      "roleAssignee~": {
        "localizedLastName": "Smith",
        "localizedFirstName": "John"
      },
      "organizationalTarget": "urn:li:organizationBrand:18085185"
    },
    {
      "organizationalTarget~": {
        "localizedName": "DevTestCo \"Quote\""
      },
      "role": "ADMINISTRATOR",
      "roleAssignee": "urn:li:person:pE3vIq7yK6",
      "state": "APPROVED",
      "roleAssignee~": {
        "localizedLastName": "Smith",
        "localizedFirstName": "John"
      },
      "organizationalTarget": "urn:li:organization:2414183"
    }
  ]
}