Skip to content

authentication_policies

authentication_policies

Authentication policy management for Domo instance configuration.

PasswordPolicies dataclass 

PasswordPolicies(
    auth: DomoAuth,
    password_reuse_history: int | None = None,
    password_expiration: int | None = None,
)

Manages password-related policies for a Domo instance.

Wraps the following policies via the customer-states API: - domo.policy.password_reuse_history: Number of previous passwords remembered (0 = disabled). - domo.policy.password_expiration: Days before a password expires (0 = never expires, 365 = annual).

Attributes:

Name Type Description
auth DomoAuth

Authentication object for API requests
password_reuse_history int | None

Cached reuse-history value (int or None)
password_expiration int | None

Cached expiration-days value (int or None)

get async 

get(
    debug_api: bool = False,
    session: AsyncClient | None = None,
    debug_num_stacks_to_drop: int = 2,
    *,
    context: RouteContext | None = None,
    **context_kwargs
)

Fetch both password policies and cache them.

Returns:

Type Description

The PasswordPolicies instance (self).
Source code in src/crew_dcs/classes/DomoInstanceConfig/authentication_policies.py 
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
async def get(
    self,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    debug_num_stacks_to_drop: int = 2,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
):
    """Fetch both password policies and cache them.

    Returns:
        The ``PasswordPolicies`` instance (self).
    """
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        debug_num_stacks_to_drop=debug_num_stacks_to_drop,
        parent_class=self.__class__.__name__,
        **context_kwargs,
    )

    await self.get_password_reuse_history(context=context)
    await self.get_password_expiration(context=context)
    return self

get_password_expiration async 

get_password_expiration(
    debug_api: bool = False,
    session: AsyncClient | None = None,
    return_raw: bool = False,
    debug_num_stacks_to_drop: int = 2,
    *,
    context: RouteContext | None = None,
    **context_kwargs
)

Fetch the current password expiration setting and cache it.

Parameters:

Name Type Description Default
debug_api bool

Log raw API requests/responses.

 False
session AsyncClient | None

Optional shared httpx session.

 None
return_raw bool

Return the raw ResponseGetData object.

 False
context RouteContext | None

Optional RouteContext.

 None

Returns:

Type Description

The PasswordPolicies instance (self) with

password_expiration populated, or a raw

ResponseGetData when return_raw is True.
Source code in src/crew_dcs/classes/DomoInstanceConfig/authentication_policies.py 
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
async def get_password_expiration(
    self,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    return_raw: bool = False,
    debug_num_stacks_to_drop: int = 2,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
):
    """Fetch the current password expiration setting and cache it.

    Args:
        debug_api: Log raw API requests/responses.
        session: Optional shared httpx session.
        return_raw: Return the raw ``ResponseGetData`` object.
        context: Optional ``RouteContext``.

    Returns:
        The ``PasswordPolicies`` instance (self) with
        ``password_expiration`` populated, or a raw
        ``ResponseGetData`` when *return_raw* is ``True``.
    """
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        debug_num_stacks_to_drop=debug_num_stacks_to_drop,
        parent_class=self.__class__.__name__,
        **context_kwargs,
    )

    res = await auth_policy_routes.get_password_expiration(
        auth=self.auth,
        return_raw=return_raw,
        context=context,
    )

    if return_raw:
        return res

    self.password_expiration = res.response
    return self

get_password_reuse_history async 

get_password_reuse_history(
    debug_api: bool = False,
    session: AsyncClient | None = None,
    return_raw: bool = False,
    debug_num_stacks_to_drop: int = 2,
    *,
    context: RouteContext | None = None,
    **context_kwargs
)

Fetch the current password reuse history setting and cache it.

Parameters:

Name Type Description Default
debug_api bool

Log raw API requests/responses.

 False
session AsyncClient | None

Optional shared httpx session.

 None
return_raw bool

Return the raw ResponseGetData object.

 False
context RouteContext | None

Optional RouteContext.

 None

Returns:

Type Description

The PasswordPolicies instance (self) with

password_reuse_history populated, or a raw

ResponseGetData when return_raw is True.
Source code in src/crew_dcs/classes/DomoInstanceConfig/authentication_policies.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
async def get_password_reuse_history(
    self,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    return_raw: bool = False,
    debug_num_stacks_to_drop: int = 2,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
):
    """Fetch the current password reuse history setting and cache it.

    Args:
        debug_api: Log raw API requests/responses.
        session: Optional shared httpx session.
        return_raw: Return the raw ``ResponseGetData`` object.
        context: Optional ``RouteContext``.

    Returns:
        The ``PasswordPolicies`` instance (self) with
        ``password_reuse_history`` populated, or a raw
        ``ResponseGetData`` when *return_raw* is ``True``.
    """
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        debug_num_stacks_to_drop=debug_num_stacks_to_drop,
        parent_class=self.__class__.__name__,
        **context_kwargs,
    )

    res = await auth_policy_routes.get_password_reuse_history(
        auth=self.auth,
        return_raw=return_raw,
        context=context,
    )

    if return_raw:
        return res

    self.password_reuse_history = res.response
    return self

set_password_expiration async 

set_password_expiration(
    expiration_days: int,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    return_raw: bool = False,
    debug_num_stacks_to_drop: int = 2,
    *,
    context: RouteContext | None = None,
    **context_kwargs
)

Set the password expiration policy.

Parameters:

Name Type Description Default
expiration_days int

Days before passwords expire. Use 0 to disable, 365 for annual expiration.

 required
debug_api bool

Log raw API requests/responses.

 False
session AsyncClient | None

Optional shared httpx session.

 None
return_raw bool

Return the raw ResponseGetData object.

 False
context RouteContext | None

Optional RouteContext.

 None

Returns:

Type Description

The PasswordPolicies instance (self) with

password_expiration updated, or a raw

ResponseGetData when return_raw is True.
Source code in src/crew_dcs/classes/DomoInstanceConfig/authentication_policies.py 
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
async def set_password_expiration(
    self,
    expiration_days: int,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    return_raw: bool = False,
    debug_num_stacks_to_drop: int = 2,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
):
    """Set the password expiration policy.

    Args:
        expiration_days: Days before passwords expire.
            Use ``0`` to disable, ``365`` for annual expiration.
        debug_api: Log raw API requests/responses.
        session: Optional shared httpx session.
        return_raw: Return the raw ``ResponseGetData`` object.
        context: Optional ``RouteContext``.

    Returns:
        The ``PasswordPolicies`` instance (self) with
        ``password_expiration`` updated, or a raw
        ``ResponseGetData`` when *return_raw* is ``True``.
    """
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        debug_num_stacks_to_drop=debug_num_stacks_to_drop,
        parent_class=self.__class__.__name__,
        **context_kwargs,
    )

    res = await auth_policy_routes.set_password_expiration(
        auth=self.auth,
        expiration_days=expiration_days,
        return_raw=return_raw,
        context=context,
    )

    if return_raw:
        return res

    self.password_expiration = res.response
    return self

set_password_reuse_history async 

set_password_reuse_history(
    history_count: int,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    return_raw: bool = False,
    debug_num_stacks_to_drop: int = 2,
    *,
    context: RouteContext | None = None,
    **context_kwargs
)

Set the password reuse history policy.

Parameters:

Name Type Description Default
history_count int

Number of previous passwords to remember (0 = disabled).

 required
debug_api bool

Log raw API requests/responses.

 False
session AsyncClient | None

Optional shared httpx session.

 None
return_raw bool

Return the raw ResponseGetData object.

 False
context RouteContext | None

Optional RouteContext.

 None

Returns:

Type Description

The PasswordPolicies instance (self) with

password_reuse_history updated, or a raw

ResponseGetData when return_raw is True.
Source code in src/crew_dcs/classes/DomoInstanceConfig/authentication_policies.py 
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
async def set_password_reuse_history(
    self,
    history_count: int,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    return_raw: bool = False,
    debug_num_stacks_to_drop: int = 2,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
):
    """Set the password reuse history policy.

    Args:
        history_count: Number of previous passwords to remember (0 = disabled).
        debug_api: Log raw API requests/responses.
        session: Optional shared httpx session.
        return_raw: Return the raw ``ResponseGetData`` object.
        context: Optional ``RouteContext``.

    Returns:
        The ``PasswordPolicies`` instance (self) with
        ``password_reuse_history`` updated, or a raw
        ``ResponseGetData`` when *return_raw* is ``True``.
    """
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        debug_num_stacks_to_drop=debug_num_stacks_to_drop,
        parent_class=self.__class__.__name__,
        **context_kwargs,
    )

    res = await auth_policy_routes.set_password_reuse_history(
        auth=self.auth,
        history_count=history_count,
        return_raw=return_raw,
        context=context,
    )

    if return_raw:
        return res

    self.password_reuse_history = res.response
    return self

toggle_password_reuse_history async 

toggle_password_reuse_history(
    is_enable_history: bool,
    history_count: int = 10,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    return_raw: bool = False,
    debug_num_stacks_to_drop: int = 2,
    *,
    context: RouteContext | None = None,
    **context_kwargs
)

Enable or disable password reuse history checking.

Parameters:

Name Type Description Default
is_enable_history bool

True to enable (using history_count), False to disable (sets count to 0).

 required
history_count int

Passwords to remember when enabling (default: 10).

 10
debug_api bool

Log raw API requests/responses.

 False
session AsyncClient | None

Optional shared httpx session.

 None
return_raw bool

Return the raw ResponseGetData object.

 False
context RouteContext | None

Optional RouteContext.

 None

Returns:

Type Description

The PasswordPolicies instance (self).
Source code in src/crew_dcs/classes/DomoInstanceConfig/authentication_policies.py 
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
async def toggle_password_reuse_history(
    self,
    is_enable_history: bool,
    history_count: int = 10,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    return_raw: bool = False,
    debug_num_stacks_to_drop: int = 2,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
):
    """Enable or disable password reuse history checking.

    Args:
        is_enable_history: ``True`` to enable (using *history_count*),
            ``False`` to disable (sets count to 0).
        history_count: Passwords to remember when enabling (default: 10).
        debug_api: Log raw API requests/responses.
        session: Optional shared httpx session.
        return_raw: Return the raw ``ResponseGetData`` object.
        context: Optional ``RouteContext``.

    Returns:
        The ``PasswordPolicies`` instance (self).
    """
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        debug_num_stacks_to_drop=debug_num_stacks_to_drop,
        parent_class=self.__class__.__name__,
        **context_kwargs,
    )

    res = await auth_policy_routes.toggle_password_reuse_history(
        auth=self.auth,
        is_enable_history=is_enable_history,
        history_count=history_count,
        return_raw=return_raw,
        context=context,
    )

    if return_raw:
        return res

    self.password_reuse_history = res.response
    return self