Account Management

Manage your platform user account, configure notifications, and get password support.

API Platform Version: 8.1 and later

Table of Contents

Account Information
  1. How do I set up a user account?
  2. I received an email inviting me to join the platform. What do I do now?
  3. What are the security questions and how are they used?
  4. How do I edit my user profile?
  5. How do I change my user name?
  6. How do I change my email address?
  7. What are the file requirements for avatar images?
  8. How do I update my user profile picture?
  9. How do I add a Gravatar image to my account?
  10. How do I upload and crop icons?
  11. How do I log out?
  12. Does the developer portal use cookies?
Password Management and Security
  1. How do I change my password?
  2. What do I do if I forget my password?
  3. My account is locked. What do I do?
  4. Why doesn't the browser remember my password?
  5. How do I change my security questions?
Notifications
  1. How do notifications work?
  2. How do I enable or disable email notifications?
  3. How do I respond to notifications?
  4. Related Topics
Roles
  1. How do roles work?
  2. A platform function is not available to me. What do I do?
  3. Related Topics

Account Information

How do I set up a user account?

It's easy to set up a new account on the platform. From the homepage, click Log In / Sign Up.

The login page shows you what signup options you have. This might vary according to how the platform version you're using is configured:

  • Create Platform Account: In most cases, you can create a platform account. Click Create Account and then, at the Sign Up page, fill in the information requested. A signup email is sent to the email address you provide; you can then click the link in the email and complete the signup process.

    Note: In some cases, signup for new users might be disabled. If this is the case, you can only sign up at the invitation of a Site Admin.

  • Use Third-Party Authentication: In many cases, you might have one or more options to sign in by using a third-party identity provider such as Facebook, Google, or CA SiteMinder. If any of these options are available on your version of the platform, you will see buttons with applicable logos on the login page. Just click the button you choose and then authenticate with the third-party provider. You will need to complete your user profile by providing first and last name and accepting the platform Terms and Conditions.

For more information on setting up user accounts, see Sign Up.

Once you've created your account and logged in, you can fine-tune your user profile. See below.

Back to top

I received an email inviting me to join the platform. What do I do now?

You might be invited to join the platform, and receive an email notification with instructions. There are two main scenarios:

  • Someone who is already a platform member invites you to join the platform.

    In this scenario, the invitation email will include a link with an invitation code. Click the link and then follow the instructions to complete signup. The invitation code is only valid for the email address the invitation was sent to.

  • The Site Admin adds you as a user.

    In this scenario, the Site Admin will contact you with the password, which you will need to complete the registration process. When you have the password, click the link in the email and follow the instructions. Depending on the platform setup, you might need to choose a new password, accept a legal agreement, and/or provide answers to security challenge questions.

Once you've created your account and logged in, you can fine-tune your user profile. See below.

Back to top

What are the security questions and how are they used?

When you create an account on the platform, you might be asked to answer one or more security questions.

Answering the security questions provides an extra layer of protection for your account. Make sure you choose questions that you can easily answer, and would always answer in the same way. Later, if you perform certain operations such as changing or resetting your password, you will be prompted to answer one or more of these questions. Your answer is checked against the answer you originally provided, and must match.

Whether the security questions are in place, how many are required, and the exact questions used might vary according to the version of the platform that you're using.

Constraints on the answers might also vary; for example, some answers might require a maximum or minimum numbers of numbers, letters, or characters, and might not allow spaces or certain special characters. If there are constraints, you will see messaging to let you know what the guidelines are.

In all cases, if you're asked to answer one or more security questions when creating an account, your responses are stored securely and are used only to protect your account.

If by any chance you don't recall the answers to the security questions, and fail to correctly answer the security question, you will see a second security question, and then, if you fail again, a third question. After three unsuccessful tries, the account is locked for a period of time, generally 30 minutes. If needed, contact the Site Admin who can reset your password.

Back to top

How do I edit my user profile?

After you create a new account, your profile is created. The top navigation includes a Profile link where you can view and edit your account information.

Note: In some cases, the platform might be set up so that you cannot modify your account information. If you need to change a value, but it is read-only, contact your Site Administrator.

The left navigation includes the following options:

  • Details page: First Name, Last Name, Profile Name (username on the platform), Email, and Avatar.
  • Forum page: The user forum aggregates forum entries for all apps, APIs, and groups the user is associated with. See Using Forums.
  • Password page: Change password.
  • Security page: The number of security questions you must answer, if any, is determined by platform settings.
  • Settings page: Manage notifications settings.
To edit user details
  1. In the top navigation, click Profile.
  2. In the left navigation menu, click Details.
  3. Update the account information as needed. Here you can change any of the following:
    • First name
    • Last name
    • Profile name
    • Email
    • Avatar
  4. Click Save.
  5. Use the top navigation to navigate to another page.
To change your password
  1. In the top navigation, click Profile.
  2. In the left navigation menu, click Password.
  3. Provide the current password.
  4. Choose the new password.
  5. Type the new password again.
  6. Click Save.
  7. Use the top navigation to navigate to another page.
To set or changes answers to security challenge questions
  1. In the top navigation, click Profile.
  2. In the left navigation menu, click Security.
  3. For each entry, choose a question from the drop-down list and then provide an answer.
  4. Click Save.
  5. Use the top navigation to navigate to another page.
To edit user settings
  1. In the top navigation, click Profile.
  2. In the left navigation menu, click Settings.
  3. Clear check boxes as needed to modify your notifications settings.
  4. Click Save.
  5. Use the top navigation to navigate to another page.

Back to top

How do I change my user name?

Your user name displays on posts, tickets, and notifications. When you initially sign up, you specify a user name on the Personal Info page. If you want to change it, you can do so on the user Details page.

To change your user name
  1. Access the user Details page (Profile > Details).
  2. Update the Profile Name field.
  3. Click Save.

For additional information on changing your user profile, see How do I edit my user profile?

Back to top

How do I change my email address?

The platform uses your email address for authentication when you log in, and also for sending email notifications to inform you about certain events such as app team changes.

You can change the email address associated with your account, on the User Settings page.

Note: In some cases, the option to change your email address might be disabled. If you need to change the email address on your account and the field is disabled, contact your Site Admin for assistance.

To change your email address
  1. Access the user Details page (Profile >Details).
  2. Update the Email field.
  3. Click Save.

For additional information on changing your user profile, see How do I edit my user profile?

Back to top

What are the file requirements for avatar images?

The file requirements for avatar images uploaded to the platform are as follows:

  • File format: jpeg, gif, tiff, bmp, or png
  • Maximum preview size: 75px x 75px
  • Maximum file size: 4MB

Back to top

How do I update my user profile picture?

The user profile avatar (picture) displays with the user name in the Logged In User area, and with App Forum, API Forum, and Dashboard posts.

You can set up an avatar for yourself via the Profile > Details page. You have two choices:

To upload a new user profile picture
  1. Access the user Details page (Profile >Details).
  2. In the Avatar section on the right, click Upload.
  3. Click Browse and then navigate to the location of your file.
  4. Click Upload. The image loads into the Upload File pop-up with the upper left corner of the file selected. This represents the default crop setting for your image (75px x 75px). Select the cropped area and drag the highlight to the area of the image you would like to display as your profile picture. You can resize the cropped area, but cannot exceed the default crop setting.
  5. Click Save.

For additional information on changing your user profile, see How do I edit my user profile?

Back to top

How do I add a Gravatar image to my account?

If you have a Gravatar account that uses the same email address as the one for your platform account, you can use the avatar you've set up on Gravatar as your avatar on the developer portal.

To set it up, you'll need to be logged in to your Gravatar account so that the platform can retrieve the image. Follow the instructions below.

To reference an image on Gravatar for a user profile picture

Note: to use this feature, you must first create an account at https://en.gravatar.com and upload an avatar.

  1. Access the Edit User Details page (Profile > Details > Edit).
  2. In the Avatar section on the right, click Use Avatar from Gravatar. The avatar changes to your Gravatar icon.
  3. Click Save.

For additional information on changing your user profile, see How do I edit my user profile?

Back to top

How do I upload and crop icons?

You can upload an icon for a specific resource such as an API, app, or group. This action can be performed in the Icon section when adding or editing the resource.

For file requirements, see What are the file requirements for avatar images? above.

To upload and crop an icon:
  1. In the Icon section for the resource, click Upload to launch the Upload File pop-up.
  2. Click Browse and then navigate to the location of your file.
  3. Click Upload. The image loads into the Upload File pop-up with the upper left corner of the file selected. This represents the default crop setting for your image (75px x 75px). Select the cropped area and drag the highlight to the area of the image you would like to display as the avatar for the resource. You can resize the cropped area, but cannot exceed the default crop setting.
  4. Click Save.

Back to top

How do I log out?

You can log out using the Logout link on the top navigation.

To log out:
  1. Access the top navigation.
  2. Click Logout.

Note: In some cases, the Site Admin might set up the platform so that it times out automatically after a period of inactivity. If this setting is in place, the specific time period is determined by the Site Admin.

Back to top

Does the developer portal use cookies?

The developer portal uses a temporary cookie, called a session cookie, to facilitate your user experience. The cookie contains information about your roles and permissions and thus enables you to take full advantage of the features offered by the portal. The cookie is established when you log in, and is removed when you log out.

The portal also uses a browser storage field to store the active session timeout value. This allows you to use more than one browser tab, and the timeout is coordinated between tabs.

Back to top

Password Management and Security

How do I change my password?

Your password is used along with your email address to sign in. You can change your user account password on the User Settings page.

If needed, you could also ask the Site Admin to change your password.

To change your password:
  1. Access the Password page (Profile >Password).
  2. Type to current password.
  3. Provide the new password and type it again in the Confirm Password field.

    Note: to help ensure account integrity, use a "strong" password that includes a mix of uppercase and lowercase with at least one or two numbers and/or special characters.

  4. Click Save.

Back to top

What do I do if I forget my password?

If you forget your password, you can request a password reset.

Note: password reset on the platform only works if you set up a user account for yourself on the platform. If you logged in via a social media provider, such as Facebook or Google, you'll need to change your password with the provider.

If needed, you could also ask the Site Admin to reset your password.

To reset your password:
  1. On the homepage, click Login / Sign-up.
  2. On the Login page, click the Forgot Password? link.
  3. Type your email address and click Continue.
  4. Go to your email account, find the password reset email, and click the link (or paste the link in the browser).
  5. Conditional: answer the security question, if applicable.
  6. Choose a new password and confirm.

Back to top

My account is locked. What do I do?

Under certain conditions, your account might be locked for security reasons. For example, if there are several failed login attempts close together (usually three), or if the Site Admin thinks your account might have been compromised, your account is locked.

If your account is locked, you can do either of the following:

  • Ask the Site Admin to unlock the account.
  • Reset your password. Changing the password automatically unlocks the account. You can only change the password if you've logged in successfully in the past (that is, your account has been active, it's not a completely new account that you're trying to access for the first time). If the platform version you're using is set up to require security challenge questions, you'll also have to correctly answer the security challenge before you could change your password. For instructions on password reset, see To reset your password above.

Back to top

Why doesn't the browser remember my password?

Many browsers allow the saving of passwords, and will sometimes offer a prompt asking if you want to save the password.

Although saving passwords is convenient, it's a potential security risk. For this reason, the platform has been modified so that even if the browser gives the save password prompt, the password is not actually saved. In addition, the auto-complete function is turned off on certain sensitive fields such as the email address at login. These changes have been made to enhance the security of our users.

We recommend that you never allow the browser to save your passwords.

Back to top

How do I change my security questions?

As part of signing up for the platform, you might be required to provide answers to one or more security questions. These are for the security of your account. For more information about security questions, see What are the security questions and how are they used?

You might want to change one or more of the security questions, or change your answer. Once you are logged in, you can do this at any time.

Note: The platform might be set up so that the answers to security questions are encrypted. If this is the case, you will see a message to that effect. Although your answers to the security questions are not shown except when you add them, your existing answers are stored. You don't need to do anything with questions and answers you don't want to change. Just provide new answers to any changed questions, or if you want to change your answer.

To change your security questions and/or answers:
  1. Log in to the platform.
  2. In the top navigation, click Profile.
  3. In the left navigation menu, click Security.
  4. Do either or both of the following:
    • To change a question, choose a new question from the drop-down list, and then type your answer.
    • To change the answer to an existing question, just type the new answer.

    Click Save.

Back to top

Notifications

How do notifications work?

The platform offers two types of notifications:

  • Dashboard notifications, displayed on your Dashboard in the platform user interface
  • Email notifications, sent to you

Dashboard notifications

When you log in, you are automatically taken to your Dashboard, where you might see one or more notifications to keep you informed of activity relating to your apps, APIs, and groups. In many cases you can take action directly from the Dashboard notification, such as accepting an invitation to a group.

In addition, after you've navigated to a different page, you can always view a summary of your notifications: in the top navigation bar, click the number indicator next to the Dashboard label. To see all notifications from this view, click the View All link at the bottom of the notifications indicator.

For more information about the Dashboard, see What information is displayed on my Dashboard?

Email notifications

Email notification messages are generated in response to certain events, such as changes relating to your apps, APIs, or groups.

For some events, such as password change, you will always receive an email notification. For other types of events, you can turn off the email notification option in your user settings. Even though the emails are not generated, you will still get Dashboard notifications for these events.

To turn off your email notifications: see How do I enable or disable email notifications?

Back to top

How do I enable or disable email notifications?

By default, the platform sends you email notifications when certain activities occur; for example, when a new member joins your app team or group. You can update your notifications settings on the User Settings page to turn email notifications off or on for certain events.

To change your notification settings:
  1. Access the Settings page (Profile > Details).
  2. If you want to change your setting for receiving news updates, check or clear the Email me news updates check box, if it is available.
  3. If you want to enable or disable email notifications, check or clear the applicable categories. Options include:
    • An app connects to my API
    • My apps receive alerts
    • There are major changes to my app's lifecycle
    • Posts are created for my apps
    • There are changes to my app's team
    • There are changes to my app's access to APIs
    • Email me news updates
    • Someone comments on my post
    • There are changes to my Private API Group
    • Tickets relating to my APIs or apps are created or updated
  4. When you're satisfied with your settings, click Save.

Back to top

How do I respond to notifications?

You can respond to notifications directly in the Dashboard or you can click the notification to display its Forum entry and respond from there.

For a list of response options to posts or tickets, see Post/Ticket Management.

Back to top

Roles

How do roles work?

There are some functions in the developer portal that don't even require login; without signing up, you can look at apps and APIs and get a feel for how it all works.

When you sign up as a platform user, new capabilities become available to you. For example, probably you can add apps or create a group. The specific functions that a general platform user can perform are governed by platform roles, which are assigned by the Administrator. For example, one user might have a role that allows adding and editing of APIs, whereas another might have a different role that only allows viewing.

If you have questions about the specific roles that are assigned to you, or the functions you can perform in the Akana API Platform, contact an Administrator.

Back to top

A platform function is not available to me. What do I do?

Certain aspects of platform functionality are controlled by the Site Admin via configurable settings. For example, you might read in the online help about how to add an API, but then find that this capability isn't available in the user interface.

Other capabilities are determined by the specific roles assigned to you (see How do roles work? above). Roles are assigned by the Business Admin.

If you find that specific capabilities aren't available to you, and you feel they should be, contact an Administrator and ask for assistance/clarification.

Back to top