Get the Salesforce permission sets that field access can be granted through, best match first. Matching is deliberately tolerant, because the name a person uses is rarely the developer name: spaces, underscores and hyphens are ignored, and the words may be given in any order, so deal desk, DealDesk and desk deal all find Deal_Desk_Team. Omit the name to list every permission set that is eligible — the case where the caller has to ask an administrator which one to use. Only permission sets the org itself owns are returned. Ones belonging to an installed managed package, including Nue's own, cannot be modified and are left out. Permission set groups are left out too; field access belongs on their member permission sets.
", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "*/*" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "name", "type": "string", "example": "", "description": "Full or partial permission set name or label. Omit to list every eligible permission set." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKeyAuth", "name": "nue-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "The matching permission sets, which may be an empty list
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "example": "", "description": "", "customType": "PermissionSetResponse[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "The Salesforce id of the permission set, the unambiguous way to name it when granting access
", "example": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "The developer name, e.g. Deal_Desk_Team
", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "description": "The label as an administrator sees it in Salesforce Setup, e.g. Deal Desk Team
", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "The administrator's own description of what the permission set is for, when they wrote one
", "example": "" }, { "name": "matchType", "kind": "optional", "type": "string", "description": "Why this permission set matched the search: exact, startsWith, contains, or all when no search term was supplied. Results are returned best-match first.
", "example": "" }, { "name": "assignedToNueUser", "kind": "optional", "type": "boolean", "description": "True when Nue's integration user holds this set. Granting a field through such a set is what lets Nue itself read and write it; a field no such set can see is invisible to Nue
", "example": "" } ], "modelRef": "#/components/schemas/PermissionSetResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Not Found", "jsonExample": "", "isExpanded": true }, { "statusCode": "501", "description": "The tenant is not Salesforce-integrated
", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "FMoCm9beq0Gelpgt7kw4D", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.nue.io/cpq/permission-sets \\\n --header 'accept: application/json'" }, { "id": "RpyETRFSonSGe2cjxol_b", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/cpq/permission-sets\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "y8PxAJSph-3gAArGbf4r_", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/cpq/permission-sets\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "dpHAmfI0IRrVlD582HTVh", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/cpq/permission-sets\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "FMoCm9beq0Gelpgt7kw4D" }, "results": { "languages": [ { "id": "38B1wyTMba9ScZRNXywtk", "language": "200", "code": "// The matching permission sets, which may be an empty list\n[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"matchType\": \"\",\n \"assignedToNueUser\": false\n }\n]" }, { "id": "kP0H2UiWetC_MDN_b1PZA", "language": "400", "code": "// Bad Request\n" }, { "id": "hTRG7_PyHPR4cdDDZrX27", "language": "404", "code": "// Not Found\n" }, { "id": "xBlxyQu7nPoJrPHnmyQMx", "language": "501", "code": "// The tenant is not Salesforce-integrated\n" } ], "selectedLanguageId": "38B1wyTMba9ScZRNXywtk" } }, "children": [ { "text": "" } ] }