• Publicity: Public Only All

authority-procs.tcl

Procs for authority management.

Location:
packages/acs-authentication/tcl/authority-procs.tcl
Created:
2003-05-14
Author:
Lars Pind <lars@collaobraid.biz>
CVS Identification:
$Id: authority-procs.tcl,v 1.39.2.8 2022/08/29 14:17:23 antoniop Exp $

Procedures in this file

Detailed information

auth::authority::batch_sync (public)

 auth::authority::batch_sync -authority_id authority_id

Execute batch synchronization for this authority now.

Switches:
-authority_id (required)
Returns:
job_id

Testcases:
sync_batch_for_local, sync_batch_ims_example_doc, sync_batch_ims_test

auth::authority::create (public)

 auth::authority::create [ -authority_id authority_id ] -array array

Create a new authentication authority.

Switches:
-authority_id (optional)
-array (required)
Name of an array containing the column values. The entries are:
  • short_name Short name for authority. Used as a key by applications to identify this authority.
  • pretty_name Label for the authority to be shown in a list to users picking an authority.
  • enabled_p 't' if this authority available, 'f' if it's disabled. Defaults to 'f'.
  • sort_order Sort ordering determines the order in which authorities are listed in the user interface. Defaults to the currently highest sort order plus one.
  • auth_impl_id The ID of the implementation of the 'auth_authentication' service contract. Defaults to none.
  • pwd_impl_id The ID of the implementation of the 'auth_password' service contract. Defaults to none.
  • forgotten_pwd_url An alternative URL to redirect to when the user has forgotten his/her password. Defaults to none.
  • change_pwd_url An alternative URL to redirect to when the user wants to change his/her password. Defaults to none.
  • register_impl_id The ID of the implementation of the 'auth_registration' service contract. Defaults to none.
  • register_url An alternative URL to redirect to when the user wants to register for an account. Defaults to none.
  • user_info_impl_id The ID of the implementation of the 'auth_user_info' service contract. Defaults to none.
  • get_doc_impl_id Id of the 'auth_sync_retrieve' service contract implementation
  • process_doc_impl_id Id of the 'auth_sync_process' service contract implementation
  • batch_sync_enabled_p Is batch sync enabled for the authority?
Options:
-authority_id
Authority_id, or blank if you want one generated for you.
Author:
Lars Pind <lars@collaboraid.biz>

Testcases:
auth_authority_api, sync_batch_ims_example_doc, sync_batch_ims_test

auth::authority::delete (public)

 auth::authority::delete -authority_id authority_id

Delete an authority.

Switches:
-authority_id (required)

Testcases:
auth_authority_api

auth::authority::edit (public)

 auth::authority::edit -authority_id authority_id -array array

Edit info about an authority. Note that there's no checking that the columns you name exist.

Switches:
-authority_id (required)
The authority you want to get.
-array (required)
Name of an array with column values to update.
Author:
Lars Pind <lars@collaboraid.biz>

Testcases:
auth_authority_api, auth_authority_edit

auth::authority::get (public)

 auth::authority::get [ -authority_id authority_id ] [ -array array ]

Get info about an authority and return the authority_id. If no authority is specified, then return

Switches:
-authority_id (optional)
The authority you want to get. If not specified, return the default authority
-array (optional)
Name of an array into which the detailed attributes should be delivered
Returns:
authority_id
Author:
Lars Pind <lars@collaboraid.biz>

Testcases:
auth_authority_api, auth_driver_get_parameter_values, auth_authority_edit

auth::authority::get_authority_options (public)

 auth::authority::get_authority_options

Returns options (value label pairs) for building the authority HTML select box.

Author:
Simon Carstensen

Testcases:
auth_authority_api

auth::authority::get_element (public)

 auth::authority::get_element [ -authority_id authority_id ] \
    -element element

Return a specific element of the auth_authority data table.

Switches:
-authority_id (optional)
-element (required)
See Also:

Testcases:
auth_authority_edit

auth::authority::get_id (public)

 auth::authority::get_id -short_name short_name

Get authority_id by short_name.

Switches:
-short_name (required)
The short_name of the authority you wish to get information for.
Returns:
authority_id or the empty string if short_name doesn't exist.
Author:
Lars Pind <lars@collaboraid.biz>

Testcases:
auth_authority_api, auth_use_email_for_login_p, auth_authority_edit, sync_snapshot, person_procs_test, party_procs_test

auth::authority::get_sc_impl_columns (public)

 auth::authority::get_sc_impl_columns

Get a list of column names for storing service contract implementation ids of the authority.

Author:
Peter Marklund

Testcases:
authority__get_sc_impl_columns

auth::authority::get_short_names (public)

 auth::authority::get_short_names

Return a list of authority short names.

Author:
Peter Marklund

Testcases:
auth_authority_api

auth::authority::local (public)

 auth::authority::local

Returns the authority_id of the local authority.

Testcases:
auth_password_reset, auth_driver_get_parameter_values, auth_use_email_for_login_p, sync_start_end, sync_actions, sync_batch_for_local
[ show source ]