Welcome to Python UCS@school Kelvin REST API Client’s documentation!

Contents:

• Python UCS@school Kelvin REST API Client
  • Features
  • Compatibility
  • Usage
  • Installation
  • Tests
    • Development internal tests
    • Local Tests
  • Logging
  • Release
  • Repo permissions
  • Credits
• Installation
  • Stable release
  • From sources
• Usage
  • Authentication and authorization
  • Correlation ID
  • Language Header
    • Set Accept-Language header within a Session context
  • Resource Role
    • Kelvin API documentation
    • Role class
    • RoleResource class
    • Create role
    • Retrieve role
    • Check if role exists
    • Search roles
    • Change role properties
    • Move role
    • Delete role
  • Resource School
    • Kelvin API documentation
    • School class
    • SchoolResource class
    • Create school
    • Retrieve school
    • Check if school exists
    • Search schools
    • Change school properties
    • Move school
    • Delete school
  • Resource SchoolClass
    • SchoolClass class
    • SchoolClassResource class
    • Create school class
    • Retrieve school class
    • Check if school class exists
    • Search school classes
    • Change school class properties
    • Move school class
    • Delete school class
  • Resource Users
    • Kelvin API documentation
    • User class
    • UserResource class
    • Create user
    • Retrieve user
    • Check if user exists
    • Search users
    • Change user properties
    • Move user
    • Delete user
  • Resource WorkGroup
    • WorkGroup class
    • WorkGroupResource class
    • Create workgroup
    • Retrieve workgroup
    • Check if workgroup exists
    • Search workgroups
    • Change workgroup properties
    • Move workgroup
    • Delete workgroup
  • Note on moving of objects
• ucsschool.kelvin.client package
  • Submodules
    • ucsschool.kelvin.client.base module
      • KelvinObject
      • KelvinResource
    • ucsschool.kelvin.client.exceptions module
      • InvalidRequest
      • InvalidToken
      • KelvinClientError
      • NoObject
      • ServerError
    • ucsschool.kelvin.client.role module
      • Role
      • RoleResource
    • ucsschool.kelvin.client.school module
      • School
      • SchoolResource
    • ucsschool.kelvin.client.school_class module
      • SchoolClass
      • SchoolClassResource
    • ucsschool.kelvin.client.session module
      • BadSettingsWarning
      • KelvinClientWarning
      • Session
      • Token
    • ucsschool.kelvin.client.user module
      • PasswordsHashes
      • User
      • UserResource
    • ucsschool.kelvin.client.workgroup module
      • WorkGroup
      • WorkGroupResource
  • Module contents
    • InvalidRequest
    • InvalidToken
    • KelvinClientError
    • KelvinObject
      • KelvinObject.as_dict()
      • KelvinObject.delete()
      • KelvinObject.reload()
      • KelvinObject.save()
    • KelvinResource
      • KelvinResource.Meta
      • KelvinResource.exists()
      • KelvinResource.get()
      • KelvinResource.get_from_url()
      • KelvinResource.search()
    • NoObject
    • PasswordsHashes
      • PasswordsHashes.as_dict()
      • PasswordsHashes.as_dict_with_ldap_attr_names()
      • PasswordsHashes.krb5_key_version_number
      • PasswordsHashes.krb_5_key
      • PasswordsHashes.krb_5_key_as_bytes
      • PasswordsHashes.samba_nt_password
      • PasswordsHashes.samba_pwd_last_set
      • PasswordsHashes.user_password
    • Role
      • Role.as_dict()
      • Role.delete()
      • Role.save()
    • RoleResource
      • RoleResource.Meta
    • School
      • School.delete()
      • School.save()
    • SchoolClass
    • SchoolClassResource
      • SchoolClassResource.Meta
    • SchoolResource
      • SchoolResource.Meta
    • ServerError
    • Session
      • Session.client
      • Session.close()
      • Session.delete()
      • Session.get()
      • Session.head()
      • Session.json_headers
      • Session.open()
      • Session.post()
      • Session.put()
      • Session.request()
      • Session.token
    • User
    • UserResource
      • UserResource.Meta
    • WorkGroup
    • WorkGroupResource
      • WorkGroupResource.Meta
• Contributing
  • Types of Contributions
    • Report Bugs
    • Fix Bugs
    • Implement Features
    • Write Documentation
    • Submit Feedback
  • Get Started!
  • Pull Request Guidelines
  • Tips
  • Deploying
• History
  • 2.2.2 (2023-04-14)
  • 2.2.1 (2022-12-15)
  • 2.2.0 (2022-10-13)
  • 2.1.0 (2022-10-07)
  • 2.0.1 (2022-10-05)
  • 2.0.0 (2022-09-10)
  • 1.7.1 (2022-08-30)
  • 1.7.0 (2022-07-07)
  • 1.6.1 (2022-06-30)
  • 1.6.0 (2022-06-27)
  • 1.5.2.1 (2022-04-05)
  • 1.5.2 (2022-02-22)
  • 1.5.1 (2021-11-30)
  • 1.5.0 (2021-09-21)
  • 0.3.0 (2021-05-04)
  • 0.2.2 (2020-11-09)
  • 0.2.1 (2020-08-07)
  • 0.2.0 (2020-04-17)
  • 0.1.0 (2020-04-16)

Indices and tables

• Index

• Module Index

• Search Page