Skip to content

GetDelegationRequestResponse

Source code in docs_src/capo_iam/types/get_delegation_request_response.py
class GetDelegationRequestResponse(TypedDict, closed=True):
    delegation_request: NotRequired[
        "capo_iam.types.delegation_request.DelegationRequest"
    ]
    """<p>The delegation request object containing all details about the request.</p>"""
    permission_check_status: NotRequired[
        "capo_iam.types.permission_check_status_type.permissionCheckStatusType"
    ]
    """<p>The status of the permission check for the delegation request.</p> <p>This value indicates the status of the process to check whether the caller has sufficient permissions to cover the requested actions in the delegation request. Since this is an asynchronous process, there are three potential values:</p> <ul> <li> <p> <code>IN_PROGRESS</code> : The permission check process has started.</p> </li> <li> <p> <code>COMPLETED</code> : The permission check process has completed. The <code>PermissionCheckResult</code> will include the result.</p> </li> <li> <p> <code>FAILED</code> : The permission check process has failed.</p> </li> </ul>"""
    permission_check_result: NotRequired[
        "capo_iam.types.permission_check_result_type.permissionCheckResultType"
    ]
    """<p>The result of the permission check, indicating whether the caller has sufficient permissions to cover the requested permissions. This is an approximate result.</p> <ul> <li> <p> <code>ALLOWED</code> : The caller has sufficient permissions cover all the requested permissions.</p> </li> <li> <p> <code>DENIED</code> : The caller does not have sufficient permissions to cover all the requested permissions.</p> </li> <li> <p> <code>UNSURE</code> : It is not possible to determine whether the caller has all the permissions needed. This output is most likely for cases when the caller has permissions with conditions.</p> </li> </ul>"""

delegation_request instance-attribute

delegation_request: NotRequired[DelegationRequest]

The delegation request object containing all details about the request.

permission_check_result instance-attribute

permission_check_result: NotRequired[permissionCheckResultType]

The result of the permission check, indicating whether the caller has sufficient permissions to cover the requested permissions. This is an approximate result.

  • ALLOWED : The caller has sufficient permissions cover all the requested permissions.

  • DENIED : The caller does not have sufficient permissions to cover all the requested permissions.

  • UNSURE : It is not possible to determine whether the caller has all the permissions needed. This output is most likely for cases when the caller has permissions with conditions.

permission_check_status instance-attribute

permission_check_status: NotRequired[permissionCheckStatusType]

The status of the permission check for the delegation request.

This value indicates the status of the process to check whether the caller has sufficient permissions to cover the requested actions in the delegation request. Since this is an asynchronous process, there are three potential values:

  • IN_PROGRESS : The permission check process has started.

  • COMPLETED : The permission check process has completed. The PermissionCheckResult will include the result.

  • FAILED : The permission check process has failed.