Using the consumer-org commands

You can use the consumer-org commands to get and list the consumer orgs on your Developer Portal service.

  1. Log in as Provider org:
    apic login --server management_server --realm provider/identity_provider --username provider_username --password provider_password
    You can determine which identity provider to use in the --realm parameter by entering the following command to see a list of all available identity providers (you do not need to be logged in to use this command):
    apic identity-providers:list --scope provider --server platform_api_host_name --fields title,realm
    For example,
    apic identity-providers:list --scope provider --server platform_api_host_name --fields title,realm 
    total_results: 2
    results:
      - title: API Manager User Registry
        realm: provider/default-idp-2
      - title: Corporate LDAP user registry
        realm: provider/corporate-ldap
    The title value should enable you to determine which identity provider to use; you can then copy the corresponding --realm parameter directly from the displayed realm value. For any identity providers that were created by your administrator after API Connect was installed, the names will have been determined at creation time. The default API Manager Local User Registry for login as a member of a provider organization is default-idp-2.

    For full details of the apic login command, see Logging in to a management server.

  2. List the consumer orgs of a site.
    For example,
    apic --mode portaladmin consumer-org:list --org orgid/name --server management_server --catalog name/id
  3. Get a consumer org from a site by using org id.
    For example,
    apic --mode portaladmin consumer-org:get --org orgid/name --server management_server --catalog name/id id