{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Partner Administrators API", "version": "1.0.0" }, "items": [ { "info": { "name": "Partner Administrators", "type": "folder" }, "items": [ { "info": { "name": "Get all customers managed by a partner admin", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/partner/organizations", "params": [ { "name": "managedBy", "value": "Y2LZY29ZCGFYAZOVL3VZL1BFT1BMRS9JOTYWOTZIYI1KYTRHLTQ3NZETYTC2ZI1KNDEZODQWZWVM1TQ", "type": "query", "description": "List customer orgs associated with this person ID." } ] }, "docs": "Get all customer organizations managed by given partner admin, in the `managedBy` request parameter. The `managedBy` user typically has the role of a Partner Admin. In case where a Partner Full Admin or Partner Read-Only admin is selected an error like \"The user already has access to all customers managed by their partner organization.\" is shown as a Partner Admin (Full and Read-Only) is able to manage all customers by default. This does not include customers managed through Customer Groups.\n\nTh" }, { "info": { "name": "Get all partner admins assigned to a customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", "params": [ { "name": "orgId", "value": "Y2LZY29ZCGFYAZOVL3VZL09SR0FOSVPBVELPTI8XZWI2NWZKZI05NJQZLTQXN2YTOTK3NC1HZDCYY2FLM9UXMGY", "type": "path", "description": "List partner admins associated with this customer org ID." } ] }, "docs": "For a given customer, get all the partner admins with their role details. This does not include partner admins who have access through Customer Groups.\nThis API can be used by Partner Full Admins.\n\nSpecify the `orgId` in the path parameter." }, { "info": { "name": "Assign partner admin to a customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", "params": [ { "name": "orgId", "value": "Y2LZY29ZCGFYAZOVL3VZL09SR0FOSVPBVELPTI85NMFIYZJHYS0ZZGNJLTEXZTUTYTE1MI1MZTM0ODE5Y2RJOWE", "type": "path", "description": "The ID of the customer organization." }, { "name": "personId", "value": "Y2LZY29ZCGFYAZOVL3VZL1BFT1BMRS80ZGEZYTI0OC05YJBHLTQXMDGTODU0NC1INTQWMZEYZTU2M2E", "type": "path", "description": "User ID of the partner admin in the partners org." } ] }, "docs": "Assign a specific Partner Admin to a customer organization. The partner admin is a user that has the Partner Administrator role.\nOther partner roles, such as Partner Full Administrator are not applicable for this API, since this role manages all customer organizations.\n\nThis API can be used b a Partner Full Admin.\n\nSpecify the `orgId` and the `personId` in the path param." }, { "info": { "name": "Unassign partner admin from a customer", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", "params": [ { "name": "orgId", "value": "Y2LZY29ZCGFYAZOVL3VZL09SR0FOSVPBVELPTI85NMFIYZJHYS0ZZGNJLTEXZTUTYTE1MI1MZTM0ODE5Y2RJOWE", "type": "path", "description": "The ID of the customer organization." }, { "name": "personId", "value": "Y2LZY29ZCGFYAZOVL3VZL1BFT1BMRS80ZGEZYTI0OC05YJBHLTQXMDGTODU0NC1INTQWMZEYZTU2M2E", "type": "path", "description": "User ID of the partner admin in the partners org." } ] }, "docs": "Unassign a specific partner admin from a customer organization. Unassigning a customer organization from a partner admin does not remove the role from the user. If a partner admin is also managing the customer organization through a Customer Group, they will continue to have access.\nThis API can be used by Partner Full Admin.\n\nSpecify the `orgId` and the `personId` in the path param." }, { "info": { "name": "Revoke all partner admin roles for a given person ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", "params": [ { "name": "personId", "value": "Y2LZY29ZCGFYAZOVL3VZL1BFT1BMRS9JOTYWOTZIYI1KYTRHLTQ3NZETYTC2ZI1KNDEZODQWZWVM1TQ", "type": "path", "description": "ID of the user whose partner roles needs to be revoked." } ] }, "docs": "Revoke all partner administrator roles from a user, thereby revoking access to Partner Hub and all managed customer organizations.\nThis action does not grant or revoke Control Hub administrator roles (e.g. Full Administrator, User and Device Administrator, etc.).\nThis API can be used by Partner Full Admin.\nSpecify the `personId` in the path param." } ] } ], "bundled": true }