Lists the handshakes that are associated with the organization that the
requesting user is part of. The ListHandshakesForOrganization
operation returns a list of handshake structures. Each structure
contains details and status about a handshake.
organizations_list_handshakes_for_organization(Filter, NextToken,
MaxResults)A filter of the handshakes that you want included in the response. The
default is all types. Use the ActionType element to limit the output
to only a specified type, such as INVITE, ENABLE-ALL-FEATURES, or
APPROVE-ALL-FEATURES. Alternatively, for the ENABLE-ALL-FEATURES
handshake that generates a separate child handshake for each member
account, you can specify the ParentHandshakeId to see only the
handshakes that were generated by that parent request.
Use this parameter if you receive a NextToken response in a previous
request that indicates that there is more output available. Set it to
the value of the previous call's NextToken response to indicate where
the output should continue from.
(Optional) Use this to limit the number of results you want included per
page in the response. If you do not include this parameter, it defaults
to a value that is specific to the operation. If additional items exist
beyond the maximum you specify, the NextToken response element is
present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get
the next part of the results. Note that Organizations might return fewer
results than the maximum even when there are more results available. You
should check NextToken after every operation to ensure that you
receive all of the results.
svc$list_handshakes_for_organization(
Filter = list(
ActionType = "INVITE"|"ENABLE_ALL_FEATURES"|"APPROVE_ALL_FEATURES"|"ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE",
ParentHandshakeId = "string"
),
NextToken = "string",
MaxResults = 123
)
Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that they are deleted and no longer accessible.
Always check the NextToken response parameter for a null value when
calling a List* operation. These operations can occasionally return an
empty set of results even when there are more results available. The
NextToken response parameter value is null only when there are no
more results to display.
This operation can be called only from the organization's master account.
# NOT RUN {
# The following example shows you how to get a list of handshakes
# associated with the current organization:
# }
# NOT RUN {
svc$list_handshakes_for_organization()
# }
# NOT RUN {
# }
Run the code above in your browser using DataCamp Workspace