REST API:accessProfile Resource

Manage access profiles using the REST API.

Learn more: REST API Conventions and Considerations.

Permissions

Users that have the Access Control permission can use this resource.

List Access Profile Records

Method: GET

URI: https://{domain}/networking/rest/accessProfile

Response

<platform>
    <accessProfile>
        <id>{recordId}</id>
         ...
    </accessProfile>

    <accessProfile>
        <id>{recordId}</id>
         ...
    </accessProfile>
      ...
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
    <recordCount>N</recordCount>      <!-- Number of __ records returned -->
</platform>

See also: REST API:Error Codes

Get an Access Profile

Method: GET

URI: https://{domain}/networking/rest/accessProfile/{recordId}

Response

<platform>
    <accessProfile>
        <name>Standard Profile</name>
        <description>The default profile for most users</description>
        <ip_addr_range></ip_addr_range>
        <global_view_permissions>false</global_view_permissions>
        <global_create_permissions>false</global_create_permissions>
        <global_update_permissions>false</global_update_permissions>
        <global_delete_permissions>false</global_delete_permissions>
        <global_admin_permissions>false</global_admin_permissions>

        <administrative_permissions>
            <user_management>true</user_management>
            <team_record_change_ownership>true</team_record_change_ownership>
            <self_record_change_ownership>true</self_record_change_ownership>
            <personalize_user_interface>false</personalize_user_interface>
            <create_delete_view_report>false</create_delete_view_report>
            <export_view_report>false</export_view_report>
            <view_report_visible_to_other>false</view_report_visible_to_other>
            <manage_global_view_report>false</manage_global_view_report>
            <manage_snapshot>false</manage_snapshot>
            <print_view_report>false</print_view_report>
            <manage_templates>false</manage_templates>
            <lead_case_assignment_policy>false</lead_case_assignment_policy>
            <override_product_pricing>false</override_product_pricing>
            <manage_self_service_portal>false</manage_self_service_portal>
            <manage_product_and_price_book>false</manage_product_and_price_book>
            <access_mass_data_operation>false</access_mass_data_operation>
            <import_export_data>false</import_export_data>
            <manage_audit_log>false</manage_audit_log>
            <manage_recycle_bin>false</manage_recycle_bin>
            <manage_tags>false</manage_tags>
            <customize_objects>false</customize_objects>
            <manage_application>true</manage_application>
            <manage_package>false</manage_package>
            <manage_develop_features>false</manage_develop_features>
            <manage_translation_workbench>false</manage_translation_workbench>
            <manage_tenant_and_company_capabilities>false</manage_...>
            <manage_discussion_category>false</manage_discussion_category>
            <proxy_login_access>false</proxy_login_access>
            <proxy_login_configuration>false</proxy_login_configuration>
            <customer_support_login>false</customer_support_login>
            <versioning>false</versioning>
            <support_cases>true</support_cases>
            <activities>true</activities>
        </administrative_permissions>
    </accessProfile>

    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>

See also: REST API:Error Codes

Add an Access Profile

Method: POST

URI: https://{domain}/networking/rest/accessProfile

Request

<platform>
    <accessProfile>
         ...
    </accessProfile>
</platform>

Response

<platform>
    <message>
        <code>0</code>
        <description>Success</description>
        <id>...</id>   <!-- ID of the newly created accessProfile -->
    </message>
</platform>

See also: REST API:Error Codes

Update an Access Profile

Method: PUT

URI: https://{domain}/networking/rest/accessProfile/{recordId}

Request

<platform>
    <accessProfile>
        ...
    </accessProfile>
</platform>

Response

<platform>
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>

See also: REST API:Error Codes

Delete an Access Profile

Method: DELETE

URI: https://{domain}/networking/rest/accessProfile/{recordId}

Response

<platform>
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>

See also: REST API:Error Codes

Dynamic Search for accessProfile Records

Method: GET

URI

https://{domain}/networking/rest/accessProfile?{query_parameters}

Query Parameters

fieldList - A comma-separated list of field names to retrieve

The asterisk (*) wildcard specifies all fields
Use the REST API:field Resource to get a complete list of fields
Field lists for database views need to specify the object's alias, as well as the field name.

filter - Filtering criteria to filter the records

For more examples, see Filter Expressions in REST APIs and the REST API Examples.)

pageSize - Number of records to retrieve from the result set in order to make a "page".
page - Number of the logical page in a database result set. The first page is page "zero" (0).

Page zero is returned by default, so appending &pageSize=1 to your query returns a single record.

getTotalRecordCount returns the number of total records.
Causes the following structure to be returned, where N is the total number of records:

<platform> 
   ...
   <message>
      <code>0</code>
      <description>Success</description>
   </message>

   <!-- added by the query param -->
   <totalRecordCount>N</totalRecordCount> 
</platform>

sortBy - Field name for primary sort
Ex: &sortBy=name
sortOrder - Sort order of the primary field, either "asc" or "desc" (ascending or descending)
Ex: &sortOrder="desc"
sortBy2 - Field name for secondary sort
sortOrder2 - Sort order of the second field, either "asc" or "desc" (ascending or descending)

For more information, see: Specifying Query Parameters in REST APIs

Response

<platform>
    <accessProfile>
        <id>{recordId}</id>
         ...
    </accessProfile>

    <accessProfile>
        <id>{recordId}</id>
         ...
    </accessProfile>
      ...

    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>

See also: REST API:Error Codes

Fields

Note: Unless otherwise indicated, the attribute for a field is "Editable on Add or Update".

Name	Type	Attribute	Description	Additional Information
name	String	Read Only
description	String		Notes and/or instructions for use
global_view_permissions	Boolean		View records in application objects
global_create_permissions	Boolean		Create records in application objects
global_update_permissions	Boolean		Update records in application objects
global_delete_permissions	Boolean		Delete records in application objects
integration_capabilities	Struct		Reserved for internal use
ip_addr_range	String		Comma separated list of IP addresses or IP-ranges from which user is allowed to access the platform

date_modified	Date	Read Only		UTC Format
date_created	Date	Read Only		UTC Format
created_id	Lookup	Read Only		User ID
modified_id	Lookup	Read Only		User ID

Team-Owned Records Permissions

Tag	Permission Tag / Flag	Type	Required During Add
team_level_record_access_permission	Tag		Individually enabled/disabled (view, update and delete record) permissions for all the of the objects belongs to user's team
object_id	lookup	Editable on Add/Update
view_capability	Boolean	Editable on Add/Update	View
update_capability	Boolean	Editable on Add/Update	Update
delete_capability	Boolean	Editable on Add/Update	Delete

Self-Owned Records Permissions

This section appears when global_administrative permissions is set to false.

Name	Type	Attribute	Description
self_record_access_permission	Tag		Individually enabled/disabled (create and self delete record) permissions for all the objects belongs to user
object_id	lookup	Editable on Add/Update
create_capability	Boolean	Editable on Add/Update
owner_delete_capability	Boolean	Editable on Add/Update

Administrative Permissions

This section appears when global_administrative permissions is set to false.

Name	Type	Attribute	Description
administrative_permission	Tag		Set of individually enabled/disabled Administrative Permissions
access_control	Boolean	Editable on Add/Update	Access Control permission
user_management	Boolean	Editable on Add/Update	User Management permission
team_record_change_ownership	Boolean	Editable on Add/Update	Change Ownership of my Team’s Records
self_record_change_ownership	Boolean	Editable on Add/Update	Change Ownership of Self Owned Records
personalize_user_interface	Boolean	Editable on Add/Update	Manage Personal Setup
create_delete_view_report	Boolean	Editable on Add/Update	Create/Delete Views/Reports/Homepages
export_view_report	Boolean	Editable on Add/Update	Export Views and Reports
view_report_visible_to_other	Boolean	Editable on Add/Update	Make Views/Reports Visible to Others
manage_global_view_report	Boolean	Editable on Add/Update	Manage Global Views/Reports
print_view_report	Boolean	Editable on Add/Update	Print using Views and Reports
manage_templates	Boolean	Editable on Add/Update
lead_case_assignment_policy	Boolean	Editable on Add/Update	Lead and Case Assignment Policies
override_product_pricing	Boolean	Editable on Add/Update
manage_product_and_price_book	Boolean	Editable on Add/Update	Manage Product and Price Book
access_mass_data_operation	Boolean	Editable on Add/Update	Access Mass Data Operations
import_export_data	Boolean	Editable on Add/Update	Import and Export Data
manage_audit_log	Boolean	Editable on Add/Update	Manage Audit Log
manage_recycle_bin	Boolean	Editable on Add/Update	Manage Recycle Bin
manage_tags	Boolean	Editable on Add/Update	Manage Tags
customize_objects	Boolean	Editable on Add/Update	Customize Objects permission
manage_application	Boolean	Editable on Add/Update	Manage Applications
manage_package	Boolean	Editable on Add/Update	Manage Packages
manage_develop_features	Boolean	Editable on Add/Update	Use Development Features
manage_translation_workbench	Boolean	Editable on Add/Update	Manage Translation Workbench
manage_tenant_and_company_capabilities	Boolean	Editable on Add/Update	Manage Tenants and Company Capabilities
proxy_login_access	Boolean	Editable on Add/Update	Proxy Login Access
proxy_login_configuration	Boolean	Editable on Add/Update
customer_support_login	Boolean	Editable on Add/Update	Customer Support Login
versioning	Boolean	Editable on Add/Update	Administer Versioning

Error Codes

Platform Code	with Http Status	Description
-7000	BAD_REQUEST (400)	Invalid ID

Learn more:

See the REST API:Error Codes for common Http error codes
See the javadoc constants for a complete list of PlatformException error-code constants.

Search

where to start

learn more

Tools

Personal tools

REST API:accessProfile Resource

Contents

Permissions

List Access Profile Records

Get an Access Profile

Add an Access Profile

Update an Access Profile

Delete an Access Profile

Dynamic Search for accessProfile Records

Fields

Team-Owned Records Permissions

Self-Owned Records Permissions

Administrative Permissions

Error Codes