list_saml_group_mappings¶
- ManagementApi.list_saml_group_mappings(role_id, mapping_type, limit=None, next_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶
Lists all the group mappings available
Returns paginated SAML group mappings for the given mappingType, grouped by SAML group.
- Parameters:
role_id (str) – User role id (required)
mapping_type (str) – Type of mappings to list (required)
limit (int) – Number of groups per page. Defaults to 100.
next_token (str) – Pagination token from a previous response
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Return type:
- Returns:
Returns the result object.
Request and Response Examples¶
HTTP: GET /samlgroupmappings/{mappingType}
Success (HTTP 200)¶
Successfully returned all the group mappings with roles/tags
Errors¶
HTTP 400
Missing required request parameters, invalid input
HTTP 500
Something went wrong at backend