Using the themes commands

You can use the themes commands to list, enable, disable, delete, and set the default themes 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_endpoint_url --fields title,realm
    For example,
    apic identity-providers:list --scope provider --server platform_api_endpoint_url --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.

    For a summary of the general-purpose commands and their use, see Developer Portal CLI commands.

  2. List the themes from a packagename.
    For example,
    apic --mode portaladmin themes:list --org orgid/name --server management_server --catalog catalogid/name --package packagename1,packagename2
    • management_server is the endpoint URL of the management server (required).
    • catalogid/name is the ID or name of the catalog that the site belongs to (required).
    • orgid/name is the ID or name of the provider organization that the catalog belongs to (required).
    • --package enables you to filter by project packages. You can use multiple comma separated values.
    • --status enables you to filter by extension status. Can be _ enabled, disabled and/or 'not installed'. You can use multiple comma separated values.
    • --custom enables you to filter your results to only the themes that you have installed on your Developer Portal site.
  3. Enable the themename theme. You can upload this theme by using the custom-theme:create-import command. For more information, see Using the custom-theme commands.
    For example,
    apic --mode portaladmin themes:enable --org orgid/name --server management_server --catalog catalogid/name --themes themename
    • --themes is the name of the theme, and can be multiple comma separated values (required).
  4. Disable the themename theme.
    For example,
    apic --mode portaladmin themes:disable --org orgid/name --server management_server --catalog catalogid/name --themes themename,theme_lib
  5. Delete the themename theme. The theme and all its dependencies must be disabled before you can delete them.
    For example,
    apic --mode portaladmin themes:delete --org orgid/name --server management_server --catalog catalogid/name --themes themename
  6. Set the themename theme to be the default theme. The theme must exist and be enabled for it to be set as a default theme.
    For example,
    apic --mode portaladmin themes:set-default --org orgid/name --server management_server --catalog catalogid/name themename
    • themename is the name of the theme to set as default.