Working in the Enterprise Context in the Developer Portal

The Developer Portal includes an Enterprise context for authorized OHIP enterprise users.

In the context, you can view, edit, and manage enterprise-level applications and environments according to your assigned enterprise role.

Enterprise context also provides centralized visibility of chain-level applications, environments, and APIs available to you across chains within the enterprise.

Chain-level applications are available from the Chain Applications subtab. Chain-level environments are available from the Chain Environments subtab. Chain-level APIs are available from the API tab.

Chain-level assets are displayed in read-only mode from the Enterprise context. You cannot create, edit, delete, approve, subscribe, remove, or otherwise manage chain-level applications, environments, or APIs from the context.

For chain-level applications, authorized users can view and copy the application key and client secret, where permitted.

To modify chain-level assets, switch to the applicable chain context.

Signing In and Selecting the Enterprise Context

Users with the required access can work in Enterprise context.

If you have access only to Enterprise context, the Developer Portal opens in Enterprise context.

If you have access to both Enterprise and chain contexts, use the context switcher to change between contexts.

When you are working in Enterprise context, the Developer Portal header displays the Enterprise ID.

Enterprise Context Permissions

Your permissions in Enterprise context depend on your assigned Enterprise role.

Users with an Enterprise administrator role, such as ENTID-OHIPADMIN, can perform the Enterprise-level tasks permitted by their role. These tasks include creating and managing Enterprise applications and environments, where supported.

Chain-level applications, environments, and APIs are displayed in read-only mode in Enterprise context. Even if you have an Enterprise administrator role, you cannot manage chain-level resources from Enterprise context. Where permitted, authorized users can view and copy a chain-level application's application key and client secret.

You cannot perform the following chain-level actions from Enterprise context:

  • Register, edit, delete, or approve applications.

  • Regenerate or change application keys and client secrets.

  • Add, remove, edit, or approve environments.

  • Manage environment credentials.

  • Subscribe to APIs or modify API subscriptions.

  • Approve chain-level requests.

To create, edit, delete, approve, subscribe to, or otherwise manage chain-level applications, environments, or APIs, switch to the applicable chain context. The actions available in chain context depend on your assigned chain-level role.

For more information about Developer Portal roles, see Assigning Roles to Users.

Viewing the Enterprise Context

  1. Sign in to the Developer Portal.
  2. Open the context switcher.
  3. Select the applicable Enterprise location.
  4. Verify that the Enterprise ID appears in the page header.

You can use the available Enterprise context options according to your assigned role.

Note:

Enterprise roles control what you can do in Enterprise context. Chain-level resources displayed in Enterprise context are view-only, even for users with Enterprise administrator access. To manage chain-level resources, switch to the applicable chain context.

Working with Enterprise Applications

Keep the following points in mind when working with Enterprise applications:
  • You create Enterprise applications in the Enterprise context.
  • Use an enterprise application when you need an application key for accessing OHIP Analytics APIs at the enterprise level.
  • Each enterprise application is scoped to one enterprise.
  • Enterprise applications are used for OHIP Analytics API access only. They do not support event subscriptions or other chain-level integration features.

Creating an Enterprise Application

Create an enterprise application to generate an application key for OHIP Analytics API access.

  1. Select the Enterprise context.

    Your assigned role must allow you to create applications.

  2. Click the Applications tab.
  3. Click Register Application or Add Application.
  4. Enter the required application details.
  5. Review the application information.
  6. Click Save or Register.

An application key is generated for the enterprise application. Use the application key for OHIP Analytics API access.

Note:

If the option to create an application is not available, your assigned role may not allow that action.

Viewing or Managing an Enterprise Application

You can view or manage enterprise applications from the Applications tab in Enterprise context.

  1. Select the Enterprise context.

    Your assigned role must allow you to view or manage enterprise applications.

  2. Click the Applications tab.
  3. Locate the enterprise application.
  4. Open the application details.
  5. Review the application information.
  6. Select the required action, if available.
  7. Save your changes or confirm the action.

Note:

If an action is not available, your assigned role may not allow that action.

Viewing and Copying Chain-Level Application Credentials

Authorized users can view and copy the application key and client secret for chain-level applications from the Chain Applications subtab.

  1. Select the Enterprise context.

    You must have permission to view application credentials.

  2. Click the Applications tab.
  3. Click the Chain Applications subtab.
  4. Locate the chain-level application.
  5. Open the application details.
  6. View the application key or client secret.
  7. Click Copy, where available.

The selected application key or client secret is copied.

Note:

Viewing or copying credentials does not modify the application or its credentials. You cannot regenerate, rotate, update, delete, or otherwise change chain-level application credentials from Enterprise context. To manage chain-level credentials, switch to the applicable chain context.

Viewing Chain-Level Environments in Enterprise Context

You can view chain-level environments available to you across chains within the enterprise from the Chain Environments subtab.

  1. Select the Enterprise context.
  2. Click the Environments tab.
  3. Click the Chain Environments subtab.
  4. Review the list of chain-level environments.
  5. Use search or filters to refine the list by chain or environment.
  6. Review the environment information.

The Chain Environments subtab displays chain-level environments available to you across chains within the enterprise.

Note:

Chain-level environments are read-only in Enterprise context. You cannot add, remove, edit, approve, or otherwise manage chain-level environments from Enterprise context. To manage a chain-level environment, switch to the applicable chain context.

Viewing Chain-Level APIs in Enterprise Context

You can view chain-level API cards available to you across chains within the enterprise.

  1. Select the Enterprise context.
  2. Click the API tab.
  3. Review the API cards.
  4. Use available search or filters to refine the list, if applicable.

Note:

The chain-level API view is read-only in Enterprise context. You cannot subscribe to or manage chain-level APIs from Enterprise context. To subscribe to or manage a chain-level API, switch to the applicable chain context.

Working in Chain Context

Use chain context when you need to manage chain-level assets.

  1. Open the context switcher.
  2. Select the applicable chain.
  3. Use the available Developer Portal options according to your chain-level role.

You can perform chain-level actions that are available for your assigned role.