ethz_iam_webservice 0.6.3

Manage users, groups and services of the ETH Identity and Access Management system (IAM)

ETHZ IAM Webservice

Manage users, groups and services of the ETH Identity and Access Management system (IAM)

Command Line Interface

When installing this module, the iam command is also installed. The basic parameters which are always needed – otherwise they will be asked interactivley – are:

$ iam -u admin-username --password MY-SECRET-PASSWORD

You can also set these environment variables instead:

$ export IAM_USERNAME=admin-username
$ export IAM_PASSWORD=MY-SECRET-PASSWORD

Group

$ iam group <group-name> -i / --info
$ iam group <group-name> -m / --members
$ iam group <group-name> -d / --delete 

$ iam group <group-name> -a user1 --add user2
$ iam group <group-name> -r user3 --remove user4

User

Get info about a user, as well as granting/revoking a service or setting its password:

$ iam user username
$ iam user username --grant-service LDAPS, -g Mailbox
$ iam user username --revoke-service LDAPS, -r Mailbox
$ iam user username --set-password [-s LDAPS [-s Mailbox]] [--service-password $trengGehe1m]

Person

Get info about a person (identity) and its users. You might either provide a username, a NPID or a email address.

$ iam person username
$ iam person [e-mail]
$ iam person 123445

Guest

Create guests. For the new guest a new username will automatically be generated. This user gets LDAP and VPN service granted. Because by policy the VPN password needs to differ from the other passwords, the result will present the two initial passwords that are set shortly after creating the guest.

CLI

$ iam guest get <username>
$ iam guest new --help
$ iam guest new -f first -l last -m [e-mail] -d "my test guest" -h host_username -a "Admingroup Name"
{
    "firstName": "first",
    "lastName": "last",
    "mail ": "[e-mail]",
    "host ": "host_username",
    "respAdminRole ": "Admingroup Name",
    "description": "my test guest",
    "dateOfBirth": "16.06.2000",
    "guestTechnicalContact": "[e-mail]",
    "notification": "To guest and host",
    "hostOrg": "06006",
    "startDate": "16.06.2021",
    "endDate": "16.06.2022",
    "username": "flast",
    "npid": "3210159",
    "init_password": "xxxxxxx",
    "init_vpn_password": "yyyyyy"
}

Default values:

• --technicalContact / -c will default to the email address of the host
• --notification / -n will default to «gh», meaning guest and host will be notified when a guest account expires.
• --startDate / -s is today.
• --endDate / -e is today + 1 year
• --dateOfBirth / -b is today's date in year 2000

Extend guest. After a year, you might want to extend the validity of your guest by another year or by a specific number of months

$ iam guest extend <username>               # will extend the guest by 1 year
$ iam guest extend <username> -m 6          # extend it by today+6 months
$ iam guest extend <username> -e 1.4.2022   # extend it until April 1st. 2022
$ iam guest extend <username> -e 2022-04-01 # same thing, different date format

## Synopsis

### Login

import ethz_iam_webservice import getpass

e = ethz_iam_webservice.login('admin4iam', getpass.getpass())

### Person

person = e.get_person('[e-mail]') person = e.get_person('some_username') person = e.get_person(123456) # npid (internal Person identifier)

person.usernames # an array of dicts of usernames person.data # raw webservice response person.firstname person.familyname person.email

etc.

### User and Services

user = person.new_user('username', 'password', 'description') user = e.get_user('username') user.services # an array of dicts of services

user.grant_service("LDAPS") user.grant_service("Active Directory") user.grant_service("Mailbox") user.grant_service("WLAN_VPN")

user.revoke_service("LDAPS")

user.delete() user.add_to_group('groupname') user.remove_from_group('groupname')

**Mailbox Service**

get service information

gs = user.get_service("Mailbox")

all attributes of the granted Mailbox service

gs.data { "sn": "Lastname", "givenName": "Firstname", "displayName": "neumond", "description": "this acccount is for creating moons", "mail": "[e-mail]", "isHidden": "false", "noMailReceive": "false", "quota": "5GB", "homeDrive": null, "homeDirectory": "\\\\d.ethz.ch\\users\\all\\neumond", "profilePath": "\\\\d.ethz.ch\\users\\all\\neumond\\%pafs", "unixHomeDirectory": "unixHomeDirectory", "loginShell": "/bin/bash", "primaryGroup": "Domain Users", "unifiedMessagingTask": null, "telephoneNumber": null, "proxyAddresses": [ "SMTP:[e-mail]", "smtp:[e-mail]" ] }

set a email-forward, description

gs.forward_address = '[e-mail]' gs.description = 'some new description' gs.save()

### Group and Group Members

**get single group** - returns a Group object or throws a ValueError if group is not found

group = e.new_group( name = 'group-name', description = 'something meaningful', admingroup = 'ID SIS', # responsible admin group targets = ['AD', 'LDAPS'], # please specify at least one target system members = ['user1', 'user2'] )

group = e.get_group('groupname') group = e.get_group(123456) # gidNumber group.data # all data received from webservice group.members # returns array of usernames or group-names group.gidNumber group.

**add/remove group members**

group.add_members('some', 'new', 'members') group.set_members('just', 'these') group.del_members('remove', 'these', 'members')

**search for groups** - Result is always a list of groups or an empty list

groups = e.get_groups(agroup='ID SIS') groups = e.get_groups(name='starts_with*') groups = e.get_groups(agroup='ID SIS', name='starts_with*')

### Mailinglists

ml = e.get_mailinglist('ID.SIS.SSDM') ml = e.get_mailinglist('[e-mail]') ml.name ml.mail ml.gidNumber ml.groupType ml.displayName ...

ml.members # returns all (direct) members of that list ml.add_members('user1', 'user2') ml.del_members('user3, 'user4')

See also [FAQ](https://gitlab.ethz.ch/vermeul/ethz-iam-webservice/-/wikis/FAQ)