Configure user limit and invitation resend interval for Consumer organization
You can use the CLI commands in the toolkit CLI to configure user limit and invitation resend interval.
Before you begin
To complete this scenario, you must have a Developer Portal enabled. The tutorial Creating the Portal explains how to enable the portal if you haven't enabled it already.
To view the management commands, see API development and management commands.
About this task
In this task, you use the toolkit CLI to configure user limit and invitation resend interval for Consumer organization.
This task takes you through the following steps:
Logging in to a management server
- 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):
For example,apic identity-providers:list --scope provider --server platform_api_endpoint_url --fields title,realm
Theapic 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
title
value should enable you to determine which identity provider to use; you can then copy the corresponding--realm
parameter directly from the displayedrealm
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 isdefault-idp-2
.For full details of the
apic login
command, see Logging in to a management server.
Obtain the .yaml file
- Run the following command to get the
catalog-setting.yaml
:
Where:apic catalog-settings:get -s <management server endpoint> -o <org name> -c <catalog name>
<management server endpoint>
is the management server endpoint (required).<org name>
is the organization name (required).<catalog name>
is the name of the catalog (required).
Edit the .yaml file
- Run the following command to edit
catalog-setting.yaml
:vi catalog-setting.yaml
- To edit the invitation interval, edit the following
parameter:
Enter the invitation delay in minutes. The default value is 0, and the maximum value is one week (10,080 minutes).corg_member_invitation_regenerate_delay: 0
- To edit the user limits, edit the following
parameter:
Enter the number of members that you want to add to the Consumer organization. The default value for this property is 2,147,483,647.max_corg_members: 2147483647
Note: When the total of existing members and pending member invitations in a consumer organization reaches the configured limit, any attempt to create a new member invitation results in an error.
Update the .yaml file
- Run the following command to update the edited
catalog-settings.yaml
:
Where:apic catalog-settings:update -s <management server endpoint> -o <org name> -c <catalog name> catalog-settings.yaml
<management server endpoint>
is the management server endpoint (required).<org name>
is the organization name (required).<catalog name>
is the name of the catalog (required).
Result
You used the toolkit CLI to configure user limit and invitation resend interval for Consumer organization.