Get Org IAM Policy

GET 
/orgs/:orgId/policies/orgiam

deprecated

Use GetDomain Settings for Organization instead

Request

Path Parameters

orgId stringrequired

Responses

200

A successful response.

application/json

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 (string)

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 (boolean)

Example (from schema)

{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-11-21T14:48:14.971Z",
      "changeDate": "2024-11-21T14:48:14.971Z",
      "resourceOwner": "69629023906488334"
    },
    "userLoginMustBeDomain": true,
    "isDefault": true
  },
  "isDefault": true
}

application/grpc

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 (string)

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 (boolean)

Example (from schema)

{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-11-21T14:48:14.972Z",
      "changeDate": "2024-11-21T14:48:14.972Z",
      "resourceOwner": "69629023906488334"
    },
    "userLoginMustBeDomain": true,
    "isDefault": true
  },
  "isDefault": true
}

application/grpc-web+proto

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 (string)

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 (boolean)

Example (from schema)

{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-11-21T14:48:14.972Z",
      "changeDate": "2024-11-21T14:48:14.972Z",
      "resourceOwner": "69629023906488334"
    },
    "userLoginMustBeDomain": true,
    "isDefault": true
  },
  "isDefault": true
}

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...