Skip to main content

signon: Rake tasks

These rake tasks come from the desc descriptions in signon’s lib/tasks folder. To change what’s shown here, change the description in the code.

access_tokens:renew_expiring_internal_tokens

Renew expiring access tokens for internal applications

k exec deploy/signon -- rake access_tokens:renew_expiring_internal_tokens

View source (lib/tasks/access_tokens.rake)

applications:create

Creates an application(OAuth client)

k exec deploy/signon -- rake applications:create

View source (lib/tasks/applications.rake)

applications:migrate_domain

Updates domain name for applications, optionally pass CSV of apps to ignore

k exec deploy/signon -- rake applications:migrate_domain[apps_to_ignore]

View source (lib/tasks/applications.rake)

data_hygiene:bulk_update_organisation

Bulk update the organisations associated with users.

k exec deploy/signon -- rake data_hygiene:bulk_update_organisation[csv_filename]

View source (lib/tasks/data_hygiene.rake)

data_hygiene:close_organisation

Mark an organisation as closed

k exec deploy/signon -- rake data_hygiene:close_organisation[content_id]

View source (lib/tasks/data_hygiene.rake)

data_hygiene:bulk_update_user_organisation

Move all users from one organisation to another

k exec deploy/signon -- rake data_hygiene:bulk_update_user_organisation[old_content_id,new_content_id]

View source (lib/tasks/data_hygiene.rake)

event_log:delete_logs_older_than_two_years

Delete all events in the event log older than 2 years

k exec deploy/signon -- rake event_log:delete_logs_older_than_two_years

View source (lib/tasks/event_log.rake)

oauth_access_grants:delete_expired

Delete expired OAuth access grants

k exec deploy/signon -- rake oauth_access_grants:delete_expired

View source (lib/tasks/oauth_access_records.rake)

oauth_access_records:delete_expired

Delete expired OAuth access grants and tokens

k exec deploy/signon -- rake oauth_access_records:delete_expired

View source (lib/tasks/oauth_access_records.rake)

organisation_mappings:zendesk_to_signon

Apply organisation mappings from Zendesk to signon users

k exec deploy/signon -- rake organisation_mappings:zendesk_to_signon

View source (lib/tasks/organisation_mappings.rake)

organisations:fetch

Fetch organisations

k exec deploy/signon -- rake organisations:fetch

View source (lib/tasks/organisations.rake)

permissions:promote_managing_editors_to_org_admins

Update anyone with a managing editor permission and a normal role to an org admin role

k exec deploy/signon -- rake permissions:promote_managing_editors_to_org_admins

View source (lib/tasks/permissions.rake)

permissions:remove_editor_permission_from_whitehall_managing_editors

Remove the ‘Editor’ permission from users in Whitehall with the ‘Managing Editor’ permission

k exec deploy/signon -- rake permissions:remove_editor_permission_from_whitehall_managing_editors

View source (lib/tasks/permissions.rake)

permissions:permissions_by_non_gds_user_and_origin

Get permissions by non-GDS user, and who gave them the permission if we have the data

k exec deploy/signon -- rake permissions:permissions_by_non_gds_user_and_origin

View source (lib/tasks/permissions.rake)

permissions:remove_inappropriately_granted_permissions_from_non_gds_users

Remove inappropriately granted permissions from non-GDS users

k exec deploy/signon -- rake permissions:remove_inappropriately_granted_permissions_from_non_gds_users

View source (lib/tasks/permissions.rake)

permissions:add_signin_permission_from_csv

Add signin permission for a specific application to users listed in a CSV using SigninPermissionGranter

k exec deploy/signon -- rake permissions:add_signin_permission_from_csv[csv_path,app_name]

View source (lib/tasks/permissions.rake)

kubernetes:sync_token_secrets

Synchronise OAuth Token secrets in Kubernetes

k exec deploy/signon -- rake kubernetes:sync_token_secrets

View source (lib/tasks/sync_kubernetes_secrets.rake)

kubernetes:sync_app_secrets

Synchronise OAuth App secrets in Kubernetes

k exec deploy/signon -- rake kubernetes:sync_app_secrets

View source (lib/tasks/sync_kubernetes_secrets.rake)

users:send_suspension_reminders

Remind users that their account will get suspended

k exec deploy/signon -- rake users:send_suspension_reminders

View source (lib/tasks/users.rake)

users:suspend_inactive

Suspend users who have not signed-in for 45 days

k exec deploy/signon -- rake users:suspend_inactive

View source (lib/tasks/users.rake)

users:suspend

Suspend a user’s access to the site (specify email in environment)

k exec deploy/signon -- rake users:suspend

View source (lib/tasks/users.rake)

users:unsuspend

Unsuspend a user’s access to the site (specify email in environment)

k exec deploy/signon -- rake users:unsuspend

View source (lib/tasks/users.rake)

users:push_permissions

Push user permission information to applications used by the user

k exec deploy/signon -- rake users:push_permissions

View source (lib/tasks/users.rake)

users:grant_application_access

Grant all active and suspended users access to an application, who don’t have access

k exec deploy/signon -- rake users:grant_application_access[application]

View source (lib/tasks/users.rake)

users:revoke_application_access

Revoke all permissions for all users of an application

k exec deploy/signon -- rake users:revoke_application_access[application]

View source (lib/tasks/users.rake)

users:grant_application_access_for_org

Grant all users in an organisation access to an application

k exec deploy/signon -- rake users:grant_application_access_for_org[application,org]

View source (lib/tasks/users.rake)

users:migrate_permissions

Migrates user permissions from source to target application

k exec deploy/signon -- rake users:migrate_permissions

View source (lib/tasks/users.rake)

users:set_2sv_by_org

Sets 2sv on all existing users by organisation

k exec deploy/signon -- rake users:set_2sv_by_org[org]

View source (lib/tasks/users.rake)

users:set_2sv_for_org

Sets 2sv on an organisation

k exec deploy/signon -- rake users:set_2sv_for_org[org]

View source (lib/tasks/users.rake)

users:set_2sv_by_email_domain

Sets 2sv on all users by email domain

k exec deploy/signon -- rake users:set_2sv_by_email_domain[domain]

View source (lib/tasks/users.rake)

users:set_2sv_for_org_admins

Sets 2sv on all organisation admin and organisation superadmin users

k exec deploy/signon -- rake users:set_2sv_for_org_admins

View source (lib/tasks/users.rake)

users:delete_expired_never_signed_in

Deletes all web users who’ve never signed in and were invited at least 90 days ago

k exec deploy/signon -- rake users:delete_expired_never_signed_in

View source (lib/tasks/users.rake)