Developer Portal Online Help
Click here to see this page in full context

Manage Users

Users with Developer Portal App Admin role can request to provide the following access types: 

On This Page 

The Dev Portal Access Tab 

  1. Access the Dev Portal Access Tab 
  2. Add GUI User 
  3. Edit GUI User 
  4. Delete GUI User 
  5. Reset GUI Password 

The API Access Tab 

  1. Access the API Access Tab 
  2. Add System User 
  3. Edit System User 
  4. Disable System User 

The Dev Portal Access Tab

Access the Dev Portal Access Tab

To access the User Management Module, App Admins must:

  1. Log into Dev Portal.
  2. Click on your User ID and select Manage Users.

  1. The Manage Users page and Dev Portal Access Tab displays, showing requests that have been made through this page. This is where App Admins can access the following features:
    • Request to add GUI users
    • Request to edit GUI users
    • Request to delete GUI users
    • Request a password reset for GUI users 


Manage Users Page - Dev Portal Access Tab

Note: If you provision users outside of this tool, users will not show up on the page. Historical data will not be shown on this page.

 

Add GUI User

App Admins can request to add additional GUI users to the Developer Portal with the following steps:

  1. Click Add User.
  2. Click Add Dev Portal User pop-up window displays.

  1. Fill out all fields: 
    • You will need to type in the full email address to confirm email, you cannot copy/paste.
    • Role Type: Select Business UserBusiness User or App Developer UserApp Developer User. 

      Business Users can access and browse the API Catalog, view information and Open API Documentation about each API available to their organization, and view and download Related Documentation for the API. 

      App Developers have all the permissions for a business user, plus the ability to create, edit and view their organization's Apps.

  2. Click ADD USER. The Success pop-up window displays. 

  1. Click OK to complete the Add User process. You will immediately see your added user populate in the list, so you know the request has been sent. 

Note: 
Credentials will be emailed directly to the user once processed within 1-3 business days.  This will include a temporary password which expires within 10 business days of email which needs to be reset to a permanent password before the expiration or the User ID will be locked. Please ensure new users are notified to check their email and spam folder for their new credentials and set their password before the 10-day expiration. 

 

Edit GUI User

App Admins can request to edit contact information or user roles for users of the Developer Portal with the following steps:

  1. Click the pencil icon  in ACTIONS column for the user you want to edit.
  2. Edit Dev Portal User pop-up window displays. 

  1. Edit fields as needed. You must type in the full email address to confirm email, you cannot copy/paste.
  2. Click UPDATE USER. 

  1. An email will be sent to the user with the requested modification details. 

Note: Please allow 1-3 business days for processing before changes are complete. 

 

Delete GUI User

For anyone that has left your company or no longer has a business need to access the Developer Portal, App Admins can request to delete the user of the Developer Portal with the following steps:

  1. Click the trash icon  in ACTIONS column for the user you want to delete.
  2. Warning: Deleting GUI User? pop-up window displays. 

  1. Confirm you have chosen the correct user you wish to delete as this action will remove the user’s access to the Developer Portal.
  2. Type DELETE (all caps) to confirm you intend to delete user.
  3. Click DELETE USER. 
  4. Successful Delete pop-up will appear. The user will no longer have access to the Developer Portal.

Reset GUI Password

App Admins can request to reset user passwords of Developer Portal.

  1. There are two ways to access the Reset Password function: 
If user displays on your Manage Users page, click the reset password icon  in ACTIONS column for user you would like to reset password for.
If user does not display on this page, click RESET PASSWORD button at the top of the page. You can use this option for anyone in your organization who has a Freddie mac Develper Portal ID. 

  1. Reset GUI Password pop-up window displays. The fields will be populated or not depending on how you accessed the Reset Password feature. 

  1. If fields are blank, fill in all information to identify the user. Note: It is most preferable to have the Existing Developer Portal User ID, otherwise make sure that the email provided is 100% accurate and what the user provided during initial access setup as the email will be used to search for the user when the Developer Portal User ID is not provided. 
  2. Click RESET. 
  3. Success pop-up window displays. 

Note: 
A new temporary password will be emailed directly to the user once processed, within 1-3 business days. This will include a temporary password which expires within 10 business days of the email date. The temporary password will need to be reset to a permanent password before the expiration or the User ID will be locked. Please ensure new users are notified to check their email and spam folders for their temporary password and reset their password before the 10-day expiration. 

The API Access Tab

Access the API Access Tab 

Users with Developer Portal App Admin role can request creation of system-to-system (S2S) credentials (System ID and System Password) for their organization with associated desired APIs. These credentials are needed to successfully call desired APIs using the Developer Portal “Try It Out” functionality, another testing tool (e.g. Postman) or when building an integration. 

 

This API Access functionality provides TEST credentials only.  

 

Note: The API Access functionality only includes select Broadly Available APIs. For access to other APIs, contact your Freddie Mac representative. 

 

To access the API Access functionality, App Admins must: 

  1. Log into Developer Portal.
  2. Click on your User ID and select Manage Users. 

  1. The Manage Users page displays with two tabs. Select the API Access tab. This is where App Admins can access the following features: 

Manage Users Page - API Access Tab 

Please review your existing access above to ensure additional credentials are necessary. S2S credentials are assigned at the organization level. 

Note: If you provision users outside of this tool, users will not show up on the page. Historical data will not be shown on this page.

Add System User

Developer Portal App Admins can request to create S2S credentials for select broadly available APIs through the Developer Portal with the following steps:

  1. Click ADD SYSTEM USER. This System User will be the registered point of contact to receive their organization’s S2S credentials.

  1. Add System User pop-up window displays.

 

  1. Fill out all fields.
    • You will need to type in the full email address to confirm email, you cannot copy/paste.
    • Select APIs: Select from the available drop-down APIs to associate with the new S2S credentials. You can select more than one API. 
  2. Click ADD USER. The Success pop-up window displays.  

 

  1. Click OKAY to complete the Add System User process. You will immediately see the user information populate in the API Access list, so you know the request for S2S credentials has been sent. 

Note: Once the request has been approved, S2S credentials are forwarded to the System User by their Freddie Mac customer representative.  Please allow 1-3 business days for processing before changes are complete. 

 

 

Edit System User 

Developer Portal App Admins can request to edit contact information or API Access for S2S credentials with the following steps: 

  1. Click pencil icon  in ACTIONS column for the user you want to edit.
  2. Edit System User pop-up window displays. 

  1. Edit fields as needed.
    • You must type in the full email address to  confirm email; you cannot copy/paste. 
    • You must fill in the Existing System ID. If you make changes to the Select APIs list, the System ID will reflect those API Access changes. 
  2. Click UPDATE USER. The Success pop-up window displays.  

  1. Once the request has been approved, an email will be sent to the System User with the requested modification details.   

Note:
Emails are sent to the System User by their Freddie Mac customer representative.  Please allow 1-3 business days for processing before changes are complete. 

 

 

Disable System User 

Developer Portal App Admins can request to disable the System ID and remove associated API access    with the following steps: 

  1. Click the trash can icon  in ACTIONS column for the user you want to delete. 
  2. Warning: Disabling System User? pop-up window displays.

  1. Confirm you have chosen the correct System User and have typed in the correct System ID, as this action will disable the System ID and remove access to all associated APIs.
  2. Type DELETE (all caps) to confirm you intend to delete the System ID and remove this System User’s access.
  3. Click DELETE USER.  
  4. Successful Delete pop-up will appear. The System ID will be disabled and can no longer be used to access APIs. 

 

 

This information is not a replacement or substitute for the requirements in the Freddie Mac Single-Family Seller/Servicer Guide or any other contractual agreements. This information does not constitute an agreement between Freddie Mac and any other party. © 2024 Freddie Mac.
Terms of Use Freddie Mac Learning