Manage organization
Organizations let you manage your accounts and users and view details of user activities
What’s an organization?
A consumer organization represents an association, such as a team or group.
Depending on your user role, you can use an organization to:
- Add users and permissions
- Manage users and permissions
- Remove users and permissions
- View API access, activity, and analytics
Organization names
Each organization name is linked to a Canada Post business profile. The business and customer names and numbers are the same in both.
Please note: You can’t change or edit the organization name through ‘Manage organization’. To edit your organization name, you must change your business profile in your Canada Post My Profile.
Organization users
A user represents a team member within an organization. A user can own or belong to any number of organizations and have different levels of permissions to contribute, administer, or view details in each.
User roles and permissions
There are 3 possible user roles in a consumer organization. They include:
- Owner/Administrator
Owns or administers the organization. An organization can have multiple administrators but only one owner. - Developer
Builds and manages apps in the developer organization. - Viewer
Views the app developer organization.
Permissions and actions
| Permission | Owner / Administrator | Developer | Viewer |
|---|---|---|---|
| Organization member | View, Manage | View | View |
| Organization settings | View, Manage | View | View |
| Organization view | View | View | View |
| Consumer product | View | View | View |
| Consumer app | View or manage production or development applications | View or manage production or development applications | View applications |
| Consumer app-dev | Manage development applications | Manage development applications | N/A |
| Consumer subscription | View application plan access in the Developer Portal | View application plan access in the Developer Portal | View production applications |
| Consumer app-analytics | View application analytics | View | View application analytics |
Access your organization
Once signed in, your organization will appear in the utility navigation header on the Developer Portal homepage. If you belong to more than one organization, use the menu to select the organization you want to access.
Invite users to your organization
If you’re the owner or administrator of an organization, you can invite users to that organization.
To invite a user:
- Go to the Developer Portal homepage.
- Select the My organization menu.
- Choose the organization you want to invite the user to. The organization summary page will open.
- Press Invite.
- Enter the user’s email address.
- Under Assign roles, select Administrator, Developer, or Viewer.
- Press Save.
An email will be sent to the specified address. The user will be added to your organization after they sign up.
Delete an organization
To delete an organization, you must:
- Be the owner of the organization
- Remain a member of at least one other organization
If you only belong to one organization, you must create a new one or join an existing one before you can delete it. Alternatively, you can delete your developer account entirely.
You must be a member of at least one organization and be the owner of that organization to delete it.
To delete an organization:
- Go to the Developer Portal homepage.
- Select the My organization menu.
- Choose the organization you want to delete.
- Select Delete organization.
- Press Delete.
- Under Assign roles, select Administrator, Developer or Viewer.
- Click Save.
Change organization owner
You can change the ownership of an organization only if you’re the owner or an administrator of that organization. The new owner must already be a member of the organization.
To change an organization owner:
- Go to the Developer Portal homepage.
- Select the My organization menu.
- Choose the organization you want to change ownership of.
- Select Change organization owner.
- Choose any existing user you want to transfer ownership to by using the dropdown.
- Using the radio buttons, select a new role for the previous owner to become.
- Press Save.
Leaving the Developer Portal
To delete your developer account, you must be the account owner.
Please note: You can only delete your account if you own one organization or none. If you own multiple organizations, you must change the ownership of those organizations or delete them until only one remains.
When you leave the portal:
- Your remaining organization and its associated data are deleted automatically.
- All members of that organization will immediately lose access to its apps and APIs.
To leave the Developer Portal:
- Select Portal settings in the top navigation.
- Select Delete account.
- Select Delete when the confirmation appears.