Get Org IAM Policy

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

Use GetDomain Settings for Organization instead

Path Parameters

• orgId string required

Responses

• 200
• 403
• 404
• default

---

A successful response.

application/json

• Schema
• Example (from schema)

---

Schema

• policy object

  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

  userLoginMustBeDomain boolean

  the username has to end with the domain of its organization

  isDefault boolean

  defines if the organization's admin changed the policy

• isDefault deprecated: is_default is also defined in zitadel.policy.v1.OrgIAMPolicy

{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-10",
      "changeDate": "2023-05-10",
      "resourceOwner": "69629023906488334"
    },
    "userLoginMustBeDomain": true,
    "isDefault": true
  },
  "isDefault": true
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• policy object

  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

  userLoginMustBeDomain boolean

  the username has to end with the domain of its organization

  isDefault boolean

  defines if the organization's admin changed the policy

• isDefault deprecated: is_default is also defined in zitadel.policy.v1.OrgIAMPolicy

{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-10",
      "changeDate": "2023-05-10",
      "resourceOwner": "69629023906488334"
    },
    "userLoginMustBeDomain": true,
    "isDefault": true
  },
  "isDefault": true
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• policy object

  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

  userLoginMustBeDomain boolean

  the username has to end with the domain of its organization

  isDefault boolean

  defines if the organization's admin changed the policy

• isDefault deprecated: is_default is also defined in zitadel.policy.v1.OrgIAMPolicy

{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-10",
      "changeDate": "2023-05-10",
      "resourceOwner": "69629023906488334"
    },
    "userLoginMustBeDomain": true,
    "isDefault": true
  },
  "isDefault": true
}

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

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

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

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

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

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

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

Returned when the resource does not exist.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

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

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

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

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

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

An unexpected error response.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

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

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

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

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

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

Loading...