Skip to content

Latest commit

 

History

History
159 lines (104 loc) · 4.02 KB

PermissionSetsApi.md

File metadata and controls

159 lines (104 loc) · 4.02 KB

Pipedrive.PermissionSetsApi

All URIs are relative to https://api.pipedrive.com/v1

Method HTTP request Description
getPermissionSet GET /permissionSets/{id} Get one Permission Set
getPermissionSetAssignments GET /permissionSets/{id}/assignments List Permission Set assignments
getPermissionSets GET /permissionSets Get all Permission Sets

getPermissionSet

SinglePermissionSetsItem getPermissionSet(id)

Get one Permission Set

Example

import Pipedrive from 'pipedrive';
let defaultClient = Pipedrive.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new Pipedrive.PermissionSetsApi();
let id = 56; // Number | ID of the permission set
apiInstance.getPermissionSet(id).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number ID of the permission set

Return type

SinglePermissionSetsItem

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getPermissionSetAssignments

UserAssignmentsToPermissionSet getPermissionSetAssignments(id, opts)

List Permission Set assignments

The list of assignments for a Permission Set

Example

import Pipedrive from 'pipedrive';
let defaultClient = Pipedrive.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new Pipedrive.PermissionSetsApi();
let id = 56; // Number | ID of the permission set
let opts = {
  'start': 0, // Number | Pagination start
  'limit': 56 // Number | Items shown per page
};
apiInstance.getPermissionSetAssignments(id, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number ID of the permission set
start Number Pagination start [optional] [default to 0]
limit Number Items shown per page [optional]

Return type

UserAssignmentsToPermissionSet

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getPermissionSets

PermissionSets getPermissionSets()

Get all Permission Sets

Example

import Pipedrive from 'pipedrive';
let defaultClient = Pipedrive.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new Pipedrive.PermissionSetsApi();
apiInstance.getPermissionSets().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

PermissionSets

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json