Skip to content

UserAccessResultItem

Source code in docs_src/capo_appfabric/types/user_access_result_item.py
class UserAccessResultItem(TypedDict, closed=True):
    app: NotRequired["capo_appfabric.types.string255.String255"]
    """<p>The name of the application.</p>"""
    tenant_id: NotRequired["capo_appfabric.types.tenant_identifier.TenantIdentifier"]
    """<p>The ID of the application tenant.</p>"""
    tenant_display_name: NotRequired["capo_appfabric.types.string2048.String2048"]
    """<p>The display name of the tenant.</p>"""
    task_id: NotRequired["capo_appfabric.types.uuid.UUID"]
    """<p>The unique ID of the task.</p>"""
    result_status: NotRequired["capo_appfabric.types.result_status.ResultStatus"]
    """<p>The status of the user access result item.</p> <p>The following states are possible:</p> <ul> <li> <p> <code>IN_PROGRESS</code>: The user access task is in progress.</p> </li> <li> <p> <code>COMPLETED</code>: The user access task completed successfully.</p> </li> <li> <p> <code>FAILED</code>: The user access task failed.</p> </li> <li> <p> <code>EXPIRED</code>: The user access task expired.</p> </li> </ul>"""
    email: NotRequired["capo_appfabric.types.email.Email"]
    """<p>The email address of the target user.</p>"""
    user_id: NotRequired[
        "capo_appfabric.types.sensitive_string2048.SensitiveString2048"
    ]
    """<p>The unique ID of user.</p>"""
    user_full_name: NotRequired[
        "capo_appfabric.types.sensitive_string2048.SensitiveString2048"
    ]
    """<p>The full name of the user.</p>"""
    user_first_name: NotRequired[
        "capo_appfabric.types.sensitive_string2048.SensitiveString2048"
    ]
    """<p>The first name of the user.</p>"""
    user_last_name: NotRequired[
        "capo_appfabric.types.sensitive_string2048.SensitiveString2048"
    ]
    """<p>The last name of the user.</p>"""
    user_status: NotRequired["str"]
    """<p>The status of the user returned by the application.</p>"""
    task_error: NotRequired["capo_appfabric.types.task_error.TaskError"]
    """<p>Contains information about an error returned from a user access task.</p>"""

app instance-attribute

app: NotRequired[String255]

The name of the application.

email instance-attribute

email: NotRequired[Email]

The email address of the target user.

result_status instance-attribute

result_status: NotRequired[ResultStatus]

The status of the user access result item.

The following states are possible:

  • IN_PROGRESS: The user access task is in progress.

  • COMPLETED: The user access task completed successfully.

  • FAILED: The user access task failed.

  • EXPIRED: The user access task expired.

task_error instance-attribute

task_error: NotRequired[TaskError]

Contains information about an error returned from a user access task.

task_id instance-attribute

task_id: NotRequired[UUID]

The unique ID of the task.

tenant_display_name instance-attribute

tenant_display_name: NotRequired[String2048]

The display name of the tenant.

tenant_id instance-attribute

tenant_id: NotRequired[TenantIdentifier]

The ID of the application tenant.

user_first_name instance-attribute

user_first_name: NotRequired[SensitiveString2048]

The first name of the user.

user_full_name instance-attribute

user_full_name: NotRequired[SensitiveString2048]

The full name of the user.

user_id instance-attribute

user_id: NotRequired[SensitiveString2048]

The unique ID of user.

user_last_name instance-attribute

user_last_name: NotRequired[SensitiveString2048]

The last name of the user.

user_status instance-attribute

user_status: NotRequired[str]

The status of the user returned by the application.