Managing communities

This REST API is used to add, view, update, or delete communities and their details.

List of resources

  • GET /communities

    Retrieves the list of communities in Developer Portal.

  • POST /communities

    Creates a new community with the given details.

  • GET /communities/{id}

    Retrieves the details of the specified community.

  • PUT /communities/{id}

    Updates the specified community.

  • DELETE /communities/{id}

    Deletes the specified community.

  • GET /communities/{id}/apis

    Retrieves the list of APIs associated with the specified community.

  • PUT /communities/{id}/apis

    Add the given APIs to the specified community.

  • DELETE /communities/{id}/apis

    Delete the given APIs from the specified community.

  • GET /communities/{id}/users

    Retrieves the list of users associated with the specified community.

  • PUT /communities/{id}/users

    Add the given users to the specified community.

  • DELETE /communities/{id}/users

    Delete the given users from the specified community.

  • GET /communities/{id}/groups

    Retrieves the list of user groups associated with the specified community.

  • PUT /communities/{id}/groups

    Add the given user groups to the specified community.

  • DELETE /communities/{id}/groups

    Delete the given user groups from the specified community.

  • PUT /communities/{id}/owner

    Update the owner of the specified community.

  • GET /communities/{id}/packages

    Retrieves the list of packages associated with the specified community.

  • PUT /communities/{id}/packages

    Add the given packages to the specified community.

  • DELETE /communities/{id}/packages

    Delete the given packages from the specified community.

  • GET /communities/{id}/ispublic

    Allows you to verify whether the specified community is a public community.

  • GET /communities/{id}/administrators

    Retrieves the list of administrators of the specified community.

Sample cURL Command

curl --location --request GET 'developer_portal_rest_base/communities/' \
--header 'Authorization: Basic basic_auth'

The communities.yaml file is located at SAGInstallDir\DeveloperPortal\developers\openapis.