Skip to content

Parent

Source code in docs_src/capo_organizations/types/parent.py
class Parent(TypedDict, closed=True):
    id: NotRequired["capo_organizations.types.parent_id.ParentId"]
    """<p>The unique identifier (ID) of the parent entity.</p> <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a parent ID string requires one of the following:</p> <ul> <li> <p> <b>Root</b> - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.</p> </li> <li> <p> <b>Organizational unit (OU)</b> - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.</p> </li> </ul>"""
    type: NotRequired["capo_organizations.types.parent_type.ParentType"]
    """<p>The type of the parent entity.</p>"""

id instance-attribute

id: NotRequired[ParentId]

The unique identifier (ID) of the parent entity.

The regex pattern for a parent ID string requires one of the following:

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

type instance-attribute

type: NotRequired[ParentType]

The type of the parent entity.