list_identities Method
Lists the identities of the given type.
Syntax
def list_identities(identity_type: int) -> None: ...
Remarks
This method is used to list the identities of the specified type. The IdentityType parameter specifies the type of identities you wish to list. Possible values are:
IdentityType | Meaning |
0 | |
1 | Domain |
2 | Both Email and Domain |
The identities property will be populated with the results. The identity_name property will contain the identity for each result. The on_identity_list event will also fire for each result.
If the number of results exceeds MaxListIdentityResults the results will be paged. When the results are paged the IsPaged configuration setting will return "True" and the identity_marker property will be populated. To obtain the next page of results simply call list_identities again. The identity_marker value determines the results offset. On the last page of results the IsPaged configuration setting will return "False" and identity_marker will be set to empty string. With this design to get all of the results you can repeatedly call list_identities until IsPaged returns "False" or identity_marker is set to empty string.