Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

A Jitterbit Harmony Security Profile

Multiexcerpt include
SpaceWithExcerptDOC
MultiExcerptNameapi-manager-banner
PageWithExcerptAPI Manager

Security Profiles

Overview

A security profile governs and secures the consumption of APIs. The profile allows you to secure one API or a group of APIs to be consumed Jitterbit Custom, OData, and Proxy APIs by a specific API consumer or a group of consumers. You can create  A member of an organization role with Write access in an environment can create and assign security profiles to APIs based on your their organization's specific security and governance requirements .

Multiple independent settings in the profile provide the ability to customize security levels. Using a combination of independent settings allows you to create specific levels of security for specific use cases.

AnchorSecProfIndexSecProfIndexSecurity Profiles Index

To access the Security Profiles page, log in to the Harmony portal and select the API Manager card. Click on My APIs in the upper left corner and select Security Profiles in the dropdown.

Image Removed

The security profiles index will be displayed, showing a repository of existing API Manager security profiles:

Image Removed

Name: The name of the security profile entered during creation of the profile.

Type: The authentication method (Anonymous, Basic, OAuth 2.0) that will be used to authenticate and access the APIs assigned to this profile.

Environment: The name of the environment selected during creation of the profile. Each security profile applies to only one environment and is used to authenticate only the APIs within the assigned environment.

Description: The optional description of the security profile. The description displays in the security profiles index.

Rate Limit: The number of API hits allowed per minute using the profile to authenticate and access the assigned APIs.

Create a New Security Profile

To create a new security profile, click the Create New Profile button.

Image Removed

For detailed instructions to create a new profile, see Security Profile Configuration

Edit an Existing Security Profile

Multiexcerpt
MultiExcerptNameeditSecProfile
  • Existing security profiles are displayed in the Security Profiles index table
  • Click the edit icon Image Removed on the appropriate row in the index table.
  • The profile creation page displays the existing assigned settings and options to make any changes. See Security Profile Creation and Configuration for additional information regarding all settings and options.
  • These options are available at the bottom of the page while editing:
    Image Removed
    • Select Save to save the changes you made.
    • Select Cancel to close the profile without saving any changes.
    • Click Delete Profile to delete the profile and remove it from the index.
      • A popup message displays requiring you to click Continue to confirm and complete the deletion. 
      • If the profile is assigned to one or more APIs, a popup message displays indicating you must first assign a different profile to the APIs before deleting it. Click Dismiss to close the popup.

Delete an Existing Security Profile

Multiexcerpt
MultiExcerptNamedeleteSecProfile
  • Existing security profiles are displayed in the Security Profiles index table.
  • Click the delete icon Image Removed on the appropriate row in the index table.
  • A popup message displays requiring you to click Continue to confirm and complete the deletion. 
  • If the profile is assigned to one or more APIs, a popup message displays indicating you must first assign a different profile to the APIs before deleting it. Click Dismiss to close the popup.
AnchorSecProfIndexSecProfIndex
Panel
borderColor#65379B
titleColor#FFFFFF
titleBGColor#65379B
titleOn This Page
Table of Content Zone

Table of Contents
maxLevel3
minLevel2

Panel
borderColor#FF7C4C
titleColor#FFFFFF
titleBGColor#FF7C4C
titleRelated Articles

(see Jitterbit Harmony Permissions and Access).

Authentication options that can be configured for API consumers to access an API that is assigned a particular security profile include Anonymous, Basic, OAuth 2.0, and API Key. Supported OAuth 2.0 identity providers include Azure Active Directory (AD), Google, Okta, and Salesforce.

Creating a security profile and assigning it to an API is not required. If you do not assign a security profile to an API, the API authentication is set to anonymous and anyone can access the API.

These pages provide detailed information on configuring a security profile and configuring a supported identity provider:

Panel
borderColor#FF7C4C
titleColor#FFFFFF
titleBGColor#FF7C4C
titlePages in This Topic

Children Display

Panel
borderColor#8C9CB4
titleColor#FFFFFF
titleBGColor#8C9CB4
titleSearch in This Topic
Page Tree Search
Panel
borderColor#00B886
titleColor#FFFFFF
titleBGColor#00B886
titleRelated Topics

HideElements
metastrue
titletrue

Last updated:  lastmodifieddate