Table of Contents

Search

  1. Preface
  2. Introduction to API Manager
  3. Managed API management
  4. API-specific policies
  5. Managed API groups
  6. Access policies
  7. Authentication and authorization
  8. Analytics

API Manager Guide

API Manager Guide

Creating a managed API group

Creating a managed API group

Create a managed API group on the
API Groups
page and add managed API to the group. You can also add a context to the group and generate JSON web token for the group.
When you create an OAuth 2.0 client, you can choose managed API groups that the OAuth 2.0 client applies to. OAuth 2.0 tokens that you generate for the client can invoke all the managed APIs in the group for which OAuth 2.0 authentication is enabled. When you generate a JSON web token for an API group, you can use the generated token to invoke any managed API in the group for which JSON Web Token (JWT) authentication is enabled. For more information, see Authentication and authorization.
If you define a context for the group,
API Manager
adds the context to the API URL of the managed APIs that belong to the group. When you add a context to a group, consider the following guidelines:
  • Group context must be unique.
  • The context cannot be identical to the name of a managed API, or to the combination of an API name and any of its versions. Also, the combination of the group context, API name, and version of any managed API that belongs to the group cannot be identical to any other URL context in the organization. For example, if you want to create a group to contain version
    b
    of managed API
    a
    , the following restrictions apply:
    • The group context cannot be
      /a/b
      .
    • If
      b
      is the default version of
      a
      , the group context cannot be
      /a
      because the API context of the default version can either include the version or not, and thus can be either
      /b/a
      or
      /a
      .
    • If
      b
      is not the default version of
      a
      , you can create a group with context
      /a
      , because the API context the non-default version always includes the version and is thus
      /a/b
      .
  • The context is case sensitive.
  • The context cannot contain a
    /t/
    segment because this segment is reserved for Informatica internal use. For example, the context cannot be
    /a/t/b
    .
  1. In the
    API Groups
    page, click
    New API Group
    .
    The
    New Group
    page appears.
  2. In the
    Name
    field enter a group name.
    The name is case sensitive and must be unique in the organization. The name can contain up to 250 characters, including any letter on the ASCII table, non-Latin characters, any digit, and the special characters . _ and -. The name cannot contain spaces or any of the following characters: " ~ ! @ # ; : % ^ . & * + = { } ( ) | < > , ' / \ $
  3. Optionally, enter a context for the group.
    API Manager
    adds the context to the API URL of the managed APIs that belong to the group.
  4. Optionally, enter a description of the group.
  5. Click
    Add APIs
    .
    The
    Add APIs to Group
    page appears.
  6. Select the APIs to add to the group and click
    Add
    .
    The
    New Group
    page lists the APIs that belong to the group in the
    APIs in Group
    section.
  7. Click
    Save
    .
    API Manager
    creates the group. The
    New Group
    page appears, showing the group details.
  8. Optionally, generate a JSON web token for the group. For more information, see Generating JSON web tokens for managed API groups.


Updated September 09, 2020