Recommended API for adding/searching organization domains on v3
Hello Zitadel crew 👋
It looks like the endpoints for adding and searching domains were deprecated on v3. What endpoint should I be using instead (on v3)?
Related endpoints:
- https://zitadel.com/docs/apis/resources/mgmt/management-service-add-org-domain
- https://zitadel.com/docs/apis/resources/mgmt/management-service-list-org-domains
(and I suppose other related ones, for e.g. removing/verifying)
ZITADEL Docs
Add a new domain to an organization. The domains are used to identify to which organization a user belongs.
ZITADEL Docs
Returns the list of registered domains of an organization. The domains are used to identify to which organization a user belongs.
4 Replies
Just found this GitHub issue: https://github.com/zitadel/zitadel/issues/9469
So I suppose there isn't a v2 API for creating/listing domains yet, right?
Can we assume that the v1 APIs will not be removed on Zitadel v4?
(btw: if it's not going to be removed on Zitadel v4, I'd suggest removing the deprecation note from the v1 domain endpoints)
GitHub
Console: Change Organization UIs to API v2 · Issue #9469 · zitade...
With the implementation of our resource API v2, we want to migrate all console requests to the new API. This issue is based on #9451 Acceptance Criteria All project request use the Zitadel v2 APIs ...
hey @bawsky good point, its already in the discussion that it could be tricky for the users to keep using API endpoints which altho works but mark as deprecated, I will check in with my team.
Thanks @Rajat! Please update me when you get a response 🙇♂️
Btw, got other questions related to this:
- is it possible to search/list domains across all organizations?
- is it possible to search for multiple domains at once?
- for context, we save domains in our database (we do this since before using Zitadel), so i.e. any of our saved companies can have N domains in the database. it'd be desirable for us to simplify searching organizations by multiple domains (logically
ORd), like it's possible on search users with orQueryZITADEL Docs
Search for users. By default, we will return all users of your instance that you have permission to read. Make sure to include a limit and sorting for pagination.
hey @bawsky any kind of global search is still not present and is wip
You should store a domain-to-orgID mapping in your own DB -> When querying users or orgs via Zitadel, use the orgID you already mapped via your DB.