get_saml_group_mapping¶
- ManagementApi.get_saml_group_mapping(saml_group_id, mapping_type, role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶
Returns a SAML group to role/tag mapping based on user input
Returns all role or tag mappings for a SAML group. Path samlGroupId must be in IdpName#GroupName format. Response SamlGroupId is the group name only.
- Parameters:
saml_group_id (str) – Composite SAML group id in IdpName#GroupName format (required)
mapping_type (str) – Type of mapping to retrieve (required)
role_id (str) – User role id (required)
_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}/{samlGroupId}
Success (HTTP 200)¶
Successfully returned the SAML group to role mapping/tag mapping
Errors¶
HTTP 400
Missing required request parameters, invalid input
HTTP 500
Something went wrong at backend