The API commands listed here are new as of FogBugz version 8.17.59.

The Basics

cmd=setPermissionsForPerson

Parameters
Requires sAclSection, ixPerson, ixSection, and sPermission.
Example
http://kakapo.fogbugz.com/api.asp?cmd=setPermissionsForPerson&ixPerson=2&sAclSection=project&ixSection=2&sPermission=none&token=9fmi9iroehfpibbpcml9577qu501eg
Returns
Empty response.
cmd=setPermissionsForGroup

Parameters
Requires sAclSection, ixPermissionGroup, ixSection, and sPermission.
Example
http://kakapo.fogbugz.com/api.asp?cmd=setPermissionsForGroup&ixPermissionGroup=2&sAclSection=project&ixSection=2&sPermission=none&token=9fmi9iroehfpibbpcml9577qu501eg
Returns
Empty response.
cmd=setPermissionsForGroupSpecial

Parameters
Requires sAclSection, sPermissionGroupGroupSpecial, ixSection, and sPermission.
Example
http://kakapo.fogbugz.com/api.asp?cmd=setPermissionsForGroupSpecial&sPermissionGroupSpecial=normal2&sAclSection=project&ixSection=2&sPermission=none&token=9fmi9iroehfpibbpcml9577qu501eg
Returns
Empty response.
cmd=getSectionsForPerson

Parameters
Requires sAclSection, ixPerson, and sMinPermission.
Example
http://kakapo.fogbugz.com/api.asp?cmd=getSectionsForPerson&ixPerson=2&sAclSection=project&ixSection=2&sMinPermission=read&token=9fmi9iroehfpibbpcml9577qu501eg
Returns
All items that belong to the specified sAclSection fand for which the person has at least the level of permission specified by sMinPermission.
cmd=getSectionsForGroup

Parameters
Requires sAclSection, ixPermissionGroup, and sMinPermission.
Example
http://kakapo.fogbugz.com/api.asp?cmd=getSectionsForGroup&ixPermissionGroup=3&sAclSection=project&ixSection=2&sMinPermission=read&token=9fmi9iroehfpibbpcml9577qu501eg
Returns
All items that belong to the specified sAclSection fand for which the user group has at least the level of permission specified by sMinPermission.
cmd=getSectionsForGroupSpecial

Parameters
Requires sAclSection, sPermissionGroupSpecial, and sMinPermission.
Example
http://kakapo.fogbugz.com/api.asp?cmd=getSectionsForGroupSpecial&sPermissionGroupSpecial=normal&sAclSection=project&ixSection=2&sMinPermission=read&token=9fmi9iroehfpibbpcml9577qu501eg
Returns
All items that belong to the specified sAclSection fand for which the user group has at least the level of permission specified by sMinPermission.
cmd=createPermissionGroup

Parameters
Requires sName. Optionally takes sNotes, and fCommunity (defaults to 0).
Example
https://kakapo.fogbugz.com/api.asp?cmd=createPermissionGroup&sName=QA&sNotes=Testers&token=kudmc9om5p93upblq474ev9m7e3ji6
Returns
The ixPermissionGroup of the newly created user group.
cmd=deletePermissionGroup

Parameters
Requires ixPermissionGroup.
Example
https://kakapo.fogbugz.com/api.asp?cmd=deletePermissionGroup&ixPermissionGroup=6&token=kudmc9om5p93upblq474ev9m7e3ji6
Returns
Empty Response
cmd=listPermissionGroups

Parameters
Optionally takes fCommunity and fDeleted.
Example
https://kakapo.fogbugz.com/api.asp?cmd=listPermissionGroups&token=kudmc9om5p93upblq474ev9m7e3ji6
Returns
Data for permission groups.
cmd=addPersonToGroup

Parameters
Requires ixPerson and ixPermissionGroup.
Example
https://kakapo.fogbugz.com/api.asp?cmd=addPersonToGroup&ixPerson=20&ixPermissionGroup=1&token=kudmc9om5p93upblq474ev9m7e3ji6
Returns
True.
cmd=removePersonFromGroup

Parameters
Requires ixPerson and ixPermissionGroup.
Example
https://kakapo.fogbugz.com/api.asp?cmd=removePersonFromGroup&ixPerson=20&ixPermissionGroup=1&token=kudmc9om5p93upblq474ev9m7e3ji6
Returns
True.

Set Permissions for a Single User (cmd=setPermissionsForPerson)

Parameters

  • sAclSection
    • Must be “Project”, “DiscussGroup”, or “Wiki”. Use this to designate the < em>type of FogBugz entity for which you are granting permissions.
  • ixPerson
    • The ID of the user for whom you are granting permission
  • ixSection 
    • The ID of the Project, Discussion Group, or Wiki
  • sPermission 
    • Must be “none”, “read”, “write”, or “admin”.

Example

URL
http://kakapo.fogbugz.com/api.asp?cmd=setPermissionsForPerson&ixPerson=2&sAclSection=project&ixSection=2&sPermission=none&token=9fmi9iroehfpibbpcml9577qu501eg
fogbugz.py
fb.setPermissionsForPerson(ixPerson=1, sAclSection="project", ixSection=2, sPermission="none")

Successful Response

XML
</response>

Set Permissions for a User Group (cmd=setPermissionsForGroup)

Parameters

  • sAclSection
    • Must be “Project”, “DiscussGroup”, or “Wiki”. Use this to designate the < em>type of FogBugz entity for which you are granting permissions.
  • ixPermissionGroup
    • The ID of the user group for whom you are granting permission
  • ixSection 
    • The ID of the Project, Discussion Group, or Wiki
  • sPermission 
    • Must be “none”, “read”, “write”, or “admin”.

Example

URL
http://your.fogbugz.dev.local/api.asp?cmd=setPermissionsForPerson&ixPerson=2&sAclSection=project&ixSection=2&sPermission=none&token=9fmi9iroehfpibbpcml9577qu501eg
fogbugz.py
fb.setPermissionsForGroup(ixPermissionGroup=3, sAclSection="project", ixSection=2, sPermission="none")

Successful Response

XML
</response>

Set Permissions for a Built In User Group (cmd=setPermissionsForGroupSpecial)

Use this command to grant permissions to normal, community, or public users.

Parameters

  • sAclSection
    • Must be “Project”, “DiscussGroup”, or “Wiki”. Use this to designate the type of FogBugz entity for which you are granting permissions.
  • sPermissionGroupSpecial
    • Must be “normal”, “community”, or “public”.
  • ixSection 
    • The ID of the Project, Discussion Group, or Wiki
  • sPermission 
    • Must be “none”, “read”, “write”, or “admin”.

Example

URL
http://kakapo.fogbugz.com/api.asp?cmd=setPermissionsForGroupSpecial&sPermissionGroupSpecial=normal&sAclSection=project&ixSection=2&sPermission=none&token=9fmi9iroehfpibbpcml9577qu501eg
fogbugz.py
fb.setPermissionsForGroupSpecial(sPermissionGroupSpecial="normal", sAclSection="project", ixSection=2, sPermission="none")

Successful Response

XML
</response>

List Sections for Which a Single User Has Been Granted Permissions (cmd=getSectionsForPerson)

Parameters

  • sAclSection
    • Must be “Project”, “DiscussGroup”, or “Wiki”. Use this to designate the type of FogBugz for which you’d like to check permissions.
  • ixPerson
    • The ID of the user whose permitted sections you’d like to see
  • ixSection 
    • The ID of the Project, Discussion Group, or Wiki
  • sMinPermission 
    • The minimum level of permission you’d like to check. Must be”read”, “write”, or “admin”.

Example

URL
http://kakapo.fogbugz.com/api.asp?cmd=getSectionsForPerson&ixPerson=2&sAclSection=project&ixSection=2&sMinPermission=read&token=9fmi9iroehfpibbpcml9577qu501eg
fogbugz.py
fb.getSectionsForPerson(ixPerson=3, sAclSection="project", sMinPermission="read")

Successful Response

XML
<response>
  <sections>
    <section>
      <ixProject>1</ixProject>
      <sProject>
        <![CDATA[ Sample Project ]]>
      </sProject>
      <ixPersonOwner>2</ixPersonOwner>
      <fDeleted>false</fDeleted>
      <fInbox>false</fInbox>
      <ixWorkflow>1</ixWorkflow>
      <sPublicSubmitEmail/>
      <sIPColumns>
        <![CDATA[ 1,8,6,7,2 ]]>
      </sIPColumns>
      <ixSection>1</ixSection>
      <iPermission>3</iPermission>
    </section>
  </sections>
</response>

List Sections for Which a User Group Has Been Granted Permissions (cmd=getSectionsForGroup)

Parameters

  • sAclSection
    • Must be “Project”, “DiscussGroup”, or “Wiki”. Use this to designate the type of FogBugz for which you’d like to check permissions.
  • ixPermissionGroup
    • The ID of the user group whose permitted sections you’d like to see
  • ixSection 
    • The ID of the Project, Discussion Group, or Wiki
  • sMinPermission 
    • The minimum level of permission you’d like to check. Must be”read”, “write”, or “admin”.

Example

URL
http://kakapo.fogbugz.com/api.asp?cmd=getSectionsForGroupn&ixPermissionGroup=3&sAclSection=project&ixSection=2&sMinPermission=read&token=9fmi9iroehfpibbpcml9577qu501eg
fogbugz.py
fb.getSectionsForGroup(ixPermissionGroup=3, sAclSection="project", sMinPermission="read")

Successful Response

XML
<response>
  <sections>
    <section>
      <ixProject>1</ixProject>
      <sProject>
        <![CDATA[ Sample Project ]]>
      </sProject>
      <ixPersonOwner>2</ixPersonOwner>
      <fDeleted>false</fDeleted>
      <fInbox>false</fInbox>
      <ixWorkflow>1</ixWorkflow>
      <sPublicSubmitEmail/>
      <sIPColumns>
        <![CDATA[ 1,8,6,7,2 ]]>
      </sIPColumns>
      <ixSection>1</ixSection>
      <iPermission>3</iPermission>
    </section>
  </sections>
</response>

List Sections for Which a Built In User Group Has Been Granted Permissions (cmd=getSectionsForGroupSpecial)

Parameters

  • sAclSection
    • Must be “Project”, “DiscussGroup”, or “Wiki”. Use this to designate the type of FogBugz for which you’d like to check permissions.
  • sPermissionGroupSpecial
    • The built in user group for which you’d like to see permitted sections. Must be “Normal”, “community”, or “public”.
  • ixSection 
    • The ID of the Project, Discussion Group, or Wiki
  • sMinPermission 
    • The minimum level of permission you’d like to check. Must be”read”, “write”, or “admin”.

Example

URL
http://kakapo.fogbugz.com/api.asp?cmd=getSectionsForGroupSpecial&sPermissionGroupSpecial=normal&sAclSection=project&ixSection=2&sMinPermission=read&token=9fmi9iroehfpibbpcml9577qu501eg
fogbugz.py
fb.getSectionsForGroupSpecial(sPermissionGroupSpecial="normal", sAclSection="project", sMinPermission="read")

Successful Response

XML
<response>
  <sections>
    <section>
      <ixProject>1</ixProject>
      <sProject>
        <![CDATA[ Sample Project ]]>
      </sProject>
      <ixPersonOwner>2</ixPersonOwner>
      <fDeleted>false</fDeleted>
      <fInbox>false</fInbox>
      <ixWorkflow>1</ixWorkflow>
      <sPublicSubmitEmail/>
      <sIPColumns>
        <![CDATA[ 1,8,6,7,2 ]]>
      </sIPColumns>
      <ixSection>1</ixSection>
      <iPermission>3</iPermission>
    </section>
  </sections>
</response>

Create a User Group (cmd=createPermissionGroup)

Parameters

  • sName
    • The name of your new user group.
  • sNotes Optional
    • Notes about your new user group.
  • fCommunity Optional
    • Defaults to “0” for false. Set to “1” to create a new community user group.

Example

URL
https://kakapo.fogbugz.com/api.asp?cmd=createPermissionGroup&sName=QA&sNotes=Testers&token=kudmc9om5p93upblq474ev9m7e3ji6
fogbugz.py
fb.createPermissionGroup(sName="QA", sNotes="Testers")

Successful Response

XML
<response>6</response>

Delete a User Group (cmd=deletePermissionGroup)

Parameters

  • ixPermissionGroup
    • The id of the permission group you’d like to delete.

Example

URL
https://kakapo.fogbugz.com/api.asp?cmd=deletePermissionGroup&ixPermissionGroup=6&token=kudmc9om5p93upblq474ev9m7e3ji6
fogbugz.py
fb.deletePermissionGroup(ixPermissionGroup=6)

Successful Response

XML
</response>

List Permission Groups (cmd=listPermissionGroups)

Parameters

  • fCommunity Optional
    • Set to 1 to return only community user groups.
  • fDeleted Optional
    • Set to 1 to return only deleted user groups.

Example

URL
https://kakapo.fogbugz.com/api.asp?cmd=listPermissionGroups&token=kudmc9om5p93upblq474ev9m7e3ji6
fogbugz.py
fb.listPermissionGroups()

Successful Response

XML
<response>
  <permissionGroups>
    <permissionGroup>
      <ixPermissionGroup>1</ixPermissionGroup>
      <sName>
        <![CDATA[ Developers ]]>
      </sName>
      <sNotes/>
      <fDeleted>false</fDeleted>
      <fCommunity>false</fCommunity>
    </permissionGroup>
    <permissionGroup>
      <ixPermissionGroup>2</ixPermissionGroup>
      <sName>
        <![CDATA[ Customers ]]>
      </sName>
      <sNotes/>
      <fDeleted>false</fDeleted>
      <fCommunity>true</fCommunity>
    </permissionGroup>
    <permissionGroup>
      <ixPermissionGroup>3</ixPermissionGroup>
      <sName>
        <![CDATA[ Support Team ]]>
      </sName>
      <sNotes/>
      <fDeleted>false</fDeleted>
      <fCommunity>false</fCommunity>
    </permissionGroup>
  </permissionGroups>
</response>

Add a User to a Group (cmd=addPersonToGroup)

Parameters

  • ixPerson
    • The ID of the user you’d like to add.
  • ixPermissionGroup
    • The ID of the group you’d like to add that user to.

Example

URL
https://kakapo.fogbugz.com/api.asp?cmd=addPersonToGroup&ixPerson=20&ixPermissionGroup=1&token=kudmc9om5p93upblq474ev9m7e3ji6
fogbugz.py
fb.addPersonToGroup(ixPerson=20, ixPermissionGroup=1)

Successful Response

XML
<response>True</response>

Remove a User from a Group (cmd=removePersonFromGroup)

Parameters

  • ixPerson
    • The ID of the user you’d like to add.
  • ixPermissionGroup
    • The ID of the group you’d like to add that user to.

Example

URL
https://kakapo.fogbugz.com/api.asp?cmd=removePersonFromGroup&ixPerson=20&ixPermissionGroup=1&token=kudmc9om5p93upblq474ev9m7e3ji6
fogbugz.py
fb.removePersonFromGroup(ixPerson=20, ixPermissionGroup=1)

Successful Response

XML
<response>True</response>