Skip to main content
Version: 1

Eazyrent IAM API

EazyRent IAM API

Description​

The EazyRent IAM API provides robust identity and access management capabilities, enabling efficient account management and permission controls across the platform. Tailored for the SaaS environment, this API allows administrators to handle user authentication, manage roles, and define permissions to secure access to various resources. By centralizing user accounts and access rules, the IAM API ensures a secure, organized, and scalable approach to managing tenant and staff permissions.

Target Audience​

  • Real Estate Agencies and Social Housing Providers: Organizations requiring a secure, structured way to manage access for staff and tenants, ensuring that only authorized users can access specific resources and functionalities.

  • Rent Guarantee Insurers: Companies that need to manage and restrict access to sensitive information, allowing only certain roles to handle tenant verification and risk assessment data.

Purpose​

The purpose of the EazyRent IAM API is to centralize identity and permission management for platform users. Through this API, businesses can handle account creation, manage user roles, assign permissions, and track access to critical resources, all while ensuring compliance and data security. This results in streamlined operations, allowing clients to configure role-based access in alignment with organizational policies and requirements.

How to use this API​

To start using the EazyRent IAM API, consult our detailed documentation, which provides information on authentication, endpoint definitions, and integration best practices. This documentation covers the steps required to manage user identities, roles, and permissions within your existing systems, ensuring secure and efficient access control across the platform.

Authentication​

Security Scheme Type:

oauth2

OAuth Flow (clientCredentials):

Scopes:

  • profile: Profile scope

  • openid: OpenId scope

  • urn:zitadel:iam:org:projects:roles: Get user roles

  • urn:zitadel:iam:user:resourceowner: Get user org

  • urn:zitadel:iam:org:project🆔310976816384838665:aud: Get grant to eazyrent project