sym.sdk.templates.approval.ApprovalTemplate¶
- class sym.sdk.templates.approval.ApprovalTemplate(srn: Union[sym.sdk.resource.SRN, str])¶
Bases:
sym.sdk.templates.template.Template
The
ApprovalTemplate
object represents a security workflow for access management supported out of the box by Sym.Read more about the sym:approval
Template
.Methods
approve
(*[, target_srn, duration])Generates a request to fire an
Event
of typeapprove
to approve an outstanding request for access to anAccessTarget
.deescalate
(*[, target_srn])Generates a request to fire an
Event
of typedeescalate
to begin deescalation of aUser
for anAccessTarget
.deny
(*[, target_srn, duration])Generates a request to fire an
Event
of typedeny
to deny an outstanding request for access to anAccessTarget
.dict
()Represent this resource as a dictionary.
escalate
(*[, target_srn, duration])Generates a request to fire an
Event
of typeescalate
to begin escalation of aUser
for anAccessTarget
.ignore
(*[, message])Generates a request to fire an
Event
of typeignore
to nullify the incomingEvent
and send a message to the actingUser
.prompt
(**kwargs)Generates a request to fire an
Event
of typeprompt
to pop up a modal for theUser
to make a request.request
(*[, target_srn, duration])Generates a request to fire an
Event
of typerequest
to submit a request for access to anAccessTarget
.Attributes
An alias for this resource's slug, derived from its
SRN
.A
SRN
object that represents the unique identifier for this resource.- classmethod approve(*, target_srn: Optional[sym.sdk.resource.SRN] = None, duration: Optional[int] = None, **kwargs)¶
Generates a request to fire an
Event
of typeapprove
to approve an outstanding request for access to anAccessTarget
.- Parameters
target_srn – The
SRN
of theAccessTarget
to request access to. Required only if firing anEvent
for aRun
which has not had a request submitted. Otherwise, defaults to the currentRun
’s requestedAccessTarget
.duration – How long the escalation should last. Required only if firing an
Event
for aRun
which has not had a request submitted. Otherwise, defaults to the currentRun
’s requested duration.**kwargs – Arbitrary additional values to pass through to the fired
Event
’s payload.
- classmethod deescalate(*, target_srn: Optional[sym.sdk.resource.SRN] = None, **kwargs)¶
Generates a request to fire an
Event
of typedeescalate
to begin deescalation of aUser
for anAccessTarget
.- Parameters
target_srn – The
SRN
of theAccessTarget
to deescalate theUser
for. Required only if firing anEvent
for aRun
which has not had a request submitted. Otherwise, defaults to the currentRun
’s requestedAccessTarget
.**kwargs – Arbitrary additional values to pass through to the fired
Event
’s payload.
- classmethod deny(*, target_srn: Optional[sym.sdk.resource.SRN] = None, duration: Optional[int] = None, **kwargs)¶
Generates a request to fire an
Event
of typedeny
to deny an outstanding request for access to anAccessTarget
.- Parameters
target_srn – The
SRN
of theAccessTarget
to request access to. Required only if firing anEvent
for aRun
which has not had a request submitted. Otherwise, defaults to the currentRun
’s requestedAccessTarget
.duration – How long the escalation should last. Required only if firing an
Event
for aRun
which has not had a request submitted. Otherwise, defaults to the currentRun
’s requested duration.**kwargs – Arbitrary additional values to pass through to the fired
Event
’s payload.
- dict()¶
Represent this resource as a dictionary.
- classmethod escalate(*, target_srn: Optional[sym.sdk.resource.SRN] = None, duration: Optional[int] = None, **kwargs)¶
Generates a request to fire an
Event
of typeescalate
to begin escalation of aUser
for anAccessTarget
.- Parameters
target_srn – The
SRN
of theAccessTarget
to escalate theUser
for. Required only if firing anEvent
for aRun
which has not had a request submitted. Otherwise, defaults to the currentRun
’s requestedAccessTarget
.duration – How long the escalation should last. Required only if firing an
Event
for aRun
which has not had a request submitted. Otherwise, defaults to the currentRun
’s requested duration.**kwargs – Arbitrary additional values to pass through to the fired
Event
’s payload.
- classmethod ignore(*, message: Optional[str] = None, **kwargs)¶
Generates a request to fire an
Event
of typeignore
to nullify the incomingEvent
and send a message to the actingUser
.
- classmethod prompt(**kwargs)¶
Generates a request to fire an
Event
of typeprompt
to pop up a modal for theUser
to make a request.- Parameters
**kwargs – Arbitrary additional values to pass through to the fired
Event
’s payload.
- classmethod request(*, target_srn: Optional[sym.sdk.resource.SRN] = None, duration: Optional[int] = None, **kwargs)¶
Generates a request to fire an
Event
of typerequest
to submit a request for access to anAccessTarget
.- Parameters
target_srn – The
SRN
of theAccessTarget
to request access to. Required only if firing anEvent
for aRun
which has not had a request submitted. Otherwise, defaults to the currentRun
’s requestedAccessTarget
.duration – How long the escalation should last. Required only if firing an
Event
for aRun
which has not had a request submitted. Otherwise, defaults to the currentRun
’s requested duration.**kwargs – Arbitrary additional values to pass through to the fired
Event
’s payload.