Get Organization By ID

GET 
/orgs/:id

Returns an organization by its ID. Make sure the user has the permissions to access the organization.

Request

Path Parameters

id stringrequired

Responses

200

requested org found

application/json

Schema

Schema

org

object

id string

details

object

sequence uint64

on read: the sequence of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

creationDate date-time

on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the

resourceOwner resource_owner is the organization an object belongs to (string)

state string

Possible values: [ORG_STATE_UNSPECIFIED, ORG_STATE_ACTIVE, ORG_STATE_INACTIVE, ORG_STATE_REMOVED]

Default value: ORG_STATE_UNSPECIFIED

current state of the organization

name string

primaryDomain string

Example (from schema)

{
  "org": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2024-11-22T09:27:13.978Z",
      "changeDate": "2024-11-22T09:27:13.978Z",
      "resourceOwner": "69629023906488334"
    },
    "state": "ORG_STATE_UNSPECIFIED",
    "name": "ZITADEL",
    "primaryDomain": "zitadel.cloud"
  }
}

application/grpc

Schema

Schema

org

object

id string

details

object

sequence uint64

on read: the sequence of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

creationDate date-time

on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the

resourceOwner resource_owner is the organization an object belongs to (string)

state string

Possible values: [ORG_STATE_UNSPECIFIED, ORG_STATE_ACTIVE, ORG_STATE_INACTIVE, ORG_STATE_REMOVED]

Default value: ORG_STATE_UNSPECIFIED

current state of the organization

name string

primaryDomain string

Example (from schema)

{
  "org": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2024-11-22T09:27:13.978Z",
      "changeDate": "2024-11-22T09:27:13.978Z",
      "resourceOwner": "69629023906488334"
    },
    "state": "ORG_STATE_UNSPECIFIED",
    "name": "ZITADEL",
    "primaryDomain": "zitadel.cloud"
  }
}

application/grpc-web+proto

Schema

Schema

org

object

id string

details

object

sequence uint64

on read: the sequence of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

creationDate date-time

on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the

resourceOwner resource_owner is the organization an object belongs to (string)

state string

Possible values: [ORG_STATE_UNSPECIFIED, ORG_STATE_ACTIVE, ORG_STATE_INACTIVE, ORG_STATE_REMOVED]

Default value: ORG_STATE_UNSPECIFIED

current state of the organization

name string

primaryDomain string

Example (from schema)

{
  "org": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2024-11-22T09:27:13.979Z",
      "changeDate": "2024-11-22T09:27:13.979Z",
      "resourceOwner": "69629023906488334"
    },
    "state": "ORG_STATE_UNSPECIFIED",
    "name": "ZITADEL",
    "primaryDomain": "zitadel.cloud"
  }
}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...