Skip to main content Skip to complementary content

Sharing APIs in Default repository

Share API contracts and API contract versions. This option is available only in Default repository.

Sharing an API contract

Add owners or editors to all versions of an API, including future versions.

Before you begin

You are an owner of the API.

Procedure

  1. In the left panel, click API actions menu next to the API name.
  2. Click Share.
  3. Select the user or group that you want to grant access to the API.
    Sharing API Contract dialog box.
  4. Edit the role of the newly added user or group, either Editor or Owner.
  5. Repeat with as many users or groups as necessary, then click Share.

Results

The selected users and groups now have access to all versions of the API contract.

Sharing an API contract version

Add a user or group as an editor of a specific API version.

Before you begin

You are an owner of the API.

Procedure

  1. You can share an API version:
    • From the left panel under the API contract, click API version actions menu next to the version, and click Share.
    • From an open API version, click API sharing.
  2. Select the user or group that you want to grant access to the API version.
    At the version level, you can only add users or groups as editors.
    Sharing API Contract version dialog box.
  3. Repeat with as many users or groups as necessary, then click Share.

Results

The selected users and groups can now edit the API version. On the homepage, under Sharing, a new icon appears.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!