Skip to content
Snippets Groups Projects
Commit e1d29f60 authored by Guillaume ROUSSE's avatar Guillaume ROUSSE
Browse files

rework POD documentation

extends synopsis to cover all use cases
reformat examples for readability
parent e4e5be6b
No related branches found
No related tags found
No related merge requests found
...@@ -316,71 +316,118 @@ __END__ ...@@ -316,71 +316,118 @@ __END__
=head1 NAME =head1 NAME
IdPAccountManager::Tools - Command line client to the Test Account manager account-manager-client.pl - Command line client to the Test Account manager
=head1 SYNOPSIS =head1 SYNOPSIS
./bin/account-manager-client.pl --list_authentication_tokens B<account-manager-client.pl> B<--add_test_account>
S<B<--account_profile> I<string>>
S<B<--sp_entityid> I<string>>
B<account-manager-client.pl> B<--list_test_accounts>
S<[B<--account_profile> I<string>]>
S<[B<--sp_entityid> I<string>]>
[B<--filter_expired>]
[B<--delete>]
B<account-manager-client.pl> B<--parse_federation_metadata>
S<[B<--sp_entityid> I<string>]>
B<account-manager-client.pl> B<--add_service_provider>
S<B<--sp_entityid> I<string>>
S<B<--contact> I<string>>
S<[B<--displayname> I<string>]>
B<account-manager-client.pl> B<--list_service_providers>
B<account-manager-client.pl> B<--list_authentication_tokens>
S<B<--sp_entityid> I<string>>
S<[B<--token> I<string>]>
[B<--filter_expired>]
[B<--delete>]
B<account-manager-client.pl> B<--get_authentication_token>
S<B<--sp_entityid> I<string>>
S<[B<--token> I<string>]>
B<account-manager-client.pl> B<--add_authentication_token>
S<B<--sp_entityid> I<string>>
S<B<--email_address> I<string>>
B<account-manager-client.pl> B<--send_notice>
S<B<--email_address> I<string>>
=head1 DESCRIPTION =head1 DESCRIPTION
The Test Account manager instanciates test accounts associated to a SAML Identity Provider. The Test Account manager instanciates test accounts associated to a SAML
This script provides a command-line interface for most functions. Identity Provider. This script provides a command-line interface for most
functions.
=head1 EXAMPLES =head1 EXAMPLES
=over 8 $> account-manager-client.pl --add_test_account \
--sp_entityid=https://test.federation.renater.fr/test/ressource
=item C<account-manager-client.pl --add_test_account --account_profile=student1 --sp_entityid=https://test.federation.renater.fr/test/ressource> --account_profile=student1 \
Adds a new test account. Adds a new test account.
=item C<account-manager-client.pl --list_test_accounts --sp_entityid=https://test.federation.renater.fr/test/ressource --account_profile=student1> $> account-manager-client.pl --list_test_accounts \
--sp_entityid=https://test.federation.renater.fr/test/ressource \
--account_profile=student1
List all test accounts. Criterias can be added to filter test accounts. List all test accounts. Criterias can be added to filter test accounts.
=item C<account-manager-client.pl --list_test_accounts --filter_expired> $> account-manager-client.pl --list_test_accounts --filter_expired
List all expired test accounts. List all expired test accounts.
=item C<account-manager-client.pl --list_test_accounts --filter_expired --delete> $> account-manager-client.pl --list_test_accounts --filter_expired \
--delete
Remove all expired test accounts from DB. Remove all expired test accounts from DB.
=item C<account-manager-client.pl --parse_federation_metadata> $> account-manager-client.pl --parse_federation_metadata
Parses the SAML metadata file, as defined by the C<federation_metadata_file_path> configuration parameter. Parses the SAML metadata file, as defined by the
C<federation_metadata_file_path> configuration parameter.
=item C<account-manager-client.pl --list_authentication_tokens --sp_entityid=https://test.federation.renater.fr/test/ressource --token=dhj67sjJ> $> account-manager-client.pl --list_authentication_tokens \
--sp_entityid=https://test.federation.renater.fr/test/ressource \
--token=dhj67sjJ
List all authentication tokens. Criterias can be added to filter tokens. List all authentication tokens. Criterias can be added to filter tokens.
=item C<account-manager-client.pl --list_authentication_tokens --filter_expired> $> account-manager-client.pl --list_authentication_tokens \
--filter_expired
List all expired authentication tokens. List all expired authentication tokens.
=item C<account-manager-client.pl --list_authentication_tokens --filter_expired --delete> $> account-manager-client.pl --list_authentication_tokens \
--filter_expired --delete
Remove all expired authentication tokens from DB. Remove all expired authentication tokens from DB.
=item C<account-manager-client.pl --get_authentication_token --token=dhj67sjJ> $> account-manager-client.pl --get_authentication_token \
--token=dhj67sjJ
Get informations on a token. Get informations on a token.
=item C<account-manager-client.pl --add_authentication_token --email_address=john@my.fqdn --sp_entityid=https://test.federation.renater.fr/test/ressource> $> account-manager-client.pl --add_authentication_token \
--email_address=john@my.fqdn \
--sp_entityid=https://test.federation.renater.fr/test/ressource
Adds a new test account. Adds a new test account.
=item C<account-manager-client.pl --send_notice --email_address=john@my.fqdn> $> account-manager-client.pl --send_notice --email_address=john@my.fqdn
Sends a mail notice to the specified email address. Sends a mail notice to the specified email address.
=item C<account-manager-client.pl --add_service_provider --sp_entityid=='https://test.federation.renater.fr/test/ressource --displayname='Test SP' --contacts=email1@dom,email2@dom> $> account-manager-client.pl --add_service_provider \
--sp_entityid=='https://test.federation.renater.fr/test/ressource _
--displayname='Test SP' --contacts=email1@dom,email2@dom
Adds a new Service provider Adds a new Service provider
=back
=head1 AUTHOR =head1 AUTHOR
Olivier Salaün (olivier.salaun@renater.fr) Olivier Salaün (olivier.salaun@renater.fr)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment