feat: org remove on admin api and org query with state (#4917)

* feat: org remove on admin api and org query with state

* docs: change description for admin api remove org

Co-authored-by: Livio Spring <livio.a@gmail.com>
This commit is contained in:
Stefan Benz
2022-12-22 10:46:06 +00:00
committed by GitHub
parent a99da4f8e4
commit 7d9fc2c6e7
7 changed files with 130 additions and 0 deletions

View File

@@ -430,6 +430,19 @@ and adds the user to the orgs members as ORG_OWNER
POST: /orgs/_setup
### RemoveOrg
> **rpc** RemoveOrg([RemoveOrgRequest](#removeorgrequest))
[RemoveOrgResponse](#removeorgresponse)
Sets the state of the organisation and all its resource (Users, Projects, Grants to and from the org) to removed
Users of this organisation will not be able login
DELETE: /orgs/{org_id}
### GetIDPByID
> **rpc** GetIDPByID([GetIDPByIDRequest](#getidpbyidrequest))
@@ -3533,6 +3546,28 @@ This is an empty request
### RemoveOrgRequest
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| org_id | string | - | string.min_len: 1<br /> string.max_len: 200<br /> |
### RemoveOrgResponse
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| details | zitadel.v1.ObjectDetails | - | |
### RemoveSMSProviderRequest

View File

@@ -95,6 +95,18 @@ title: zitadel/org.proto
| ----- | ---- | ----------- | ----------- |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.name_query | OrgNameQuery | - | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.domain_query | OrgDomainQuery | - | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.state_query | OrgStateQuery | - | |
### OrgStateQuery
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| state | OrgState | - | enum.defined_only: true<br /> |