Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
E
eduGAIN Access Check - Account manager
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
edugain
eduGAIN Access Check - Account manager
Commits
e1d29f60
Commit
e1d29f60
authored
7 years ago
by
Guillaume ROUSSE
Browse files
Options
Downloads
Patches
Plain Diff
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
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
bin/account-manager-client.pl
+68
-21
68 additions, 21 deletions
bin/account-manager-client.pl
with
68 additions
and
21 deletions
bin/account-manager-client.pl
+
68
−
21
View file @
e1d29f60
...
...
@@ -316,71 +316,118 @@ __END__
=head1 NAME
IdPA
ccount
M
anager
::Tools
- Command line client to the Test Account manager
a
ccount
-m
anager
-client.pl
- Command line client to the Test Account manager
=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
The Test Account manager instanciates test accounts associated to a SAML Identity Provider.
This script provides a command-line interface for most functions.
The Test Account manager instanciates test accounts associated to a SAML
Identity Provider. This script provides a command-line interface for most
functions.
=head1 EXAMPLES
=over 8
=item C<account-manager-client.pl --add_test_account --account_profile=student1 --sp_entityid=https://test.federation.renater.fr/test/ressource>
$> account-manager-client.pl --add_test_account \
--sp_entityid=https://test.federation.renater.fr/test/ressource
--account_profile=student1 \
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.
=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.
=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.
=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.
=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.
=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.
=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.
=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.
=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.
=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
=back
=head1 AUTHOR
Olivier Salaün (olivier.salaun@renater.fr)
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment