authentik/website/docs/developer-docs/api/reference/providers-saml-preview-user-retrieve.api.mdx

---
id: providers-saml-preview-user-retrieve
title: "providers_saml_preview_user_retrieve"
description: "Preview user data for provider"
sidebar_label: "providers_saml_preview_user_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytVF1v2jAU/SuWnzYJkYr2YeJpbEIVUtnQ2j1VCJnkQlyM7doOXYTy33dvHMAtdJOmPSW278c5537subHgRJBGTwo+5NaZnSzA+YUXW7WwDnYSXhaVB7dwEJyEHfAeL8DnTlpyQ6dZtGJkxQoRBFsZxw6h0NwKJ7YQMCwfPu65JKfnClyNbxpf8IgebRa88XkJW8GHex5qS29SB1jjU9P0OmcrQnnylcUfvd7CHbFKS0zPOgu2E4pOBeggV7XUaxZK6dn9aHrHZh2LPqZw8FxJB6hTcBU08x4PYk2UTrJxvPSQV06GuuUqqlBS3A2e5uTiwFujPXiCOri6ok9uEIkO9CusVTJvC5I9ecK7P6dmlk+Qh3frUJoXZAAMYTgMG+uChLYYHAq2k6J9RtBY+1C398jaMw8K46KJ1Ey8KmA0lRF11xWXAImikIRGqFnq0hBvUXzXqu7Ea1I5H48hSVMZFLRsIrxpRNeRwyY4KyiV+CYq+frhiygYZQEfos31f1T7FjQ4mbPRbMLGzplznQoIQqokkscB0muCkpsCLjy8UaULkIjSJY35LkqBVzhqpaFpXkNopw+HZcizY5NmNNvZXhZNlg54RlMEbncY08opchNWZrvrjDdJa9+TRpFk0uBHOmUI9jCSdF6CcHF+cSpXprXsCJ3ce5wyRxqDq8FN/1N/cCb6VGxoPg9esXTMy61VQCNKtRV5W1ssIonPS1DKfF6bY6a+NFQCLDzgHJJpt0emkwcMEWkTBT/MsrUMZbXs52abJSGy099SmWWGqXR2N/k6/nY/bmla48NW6CT4UX1G6jOb7sz3NmvSq39fsp32AX6FzCoERCRbMvuuBdI9hdVBGPgZttsz7QM8UsuVSIF89vul8PDTqaah67i3qT8K6cVSUaeuhPLQ4xuoX2/ydrG2XTmng5Nkf9n3Xd4ffnQD8ZH98+K+KE13KXSdIj2wQFWaOVqVuLaQC2GOD6M8BxsSl7MdQmSPI3g7pp6idknmo5uH3uGHol+Eg9q3Fg9mAxr1P6ALdCaATfMb1n2xYQ==
sidebar_class_name: "get api-method"
info_path: docs/developer-docs/api/reference/authentik
custom_edit_url: null
hide_send_button: true
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"providers_saml_preview_user_retrieve"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/providers/saml/{id}/preview_user/"}
>
  
</MethodEndpoint>



Preview user data for provider

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<details
  style={{"marginBottom":"1rem"}}
  className={"openapi-markdown__details"}
  data-collapsed={false}
  open={true}
>
  <summary
    style={{}}
  >
    <h3
      className={"openapi-markdown__details-summary-header-params"}
    >
      Path Parameters
    </h3>
  </summary><div>
    <ul>
      <ParamsItem
        className={"paramsItem"}
        param={{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this SAML Provider.","required":true}}
      >
        
      </ParamsItem>
    </ul>
  </div>
</details><details
  style={{"marginBottom":"1rem"}}
  className={"openapi-markdown__details"}
  data-collapsed={false}
  open={true}
>
  <summary
    style={{}}
  >
    <h3
      className={"openapi-markdown__details-summary-header-params"}
    >
      Query Parameters
    </h3>
  </summary><div>
    <ul>
      <ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"for_user","schema":{"type":"integer"}}}
      >
        
      </ParamsItem>
    </ul>
  </div>
</details><div>
  <div>
    <ApiTabs
      label={undefined}
      id={undefined}
    >
      <TabItem
        label={"200"}
        value={"200"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={true}
                        className={"schemaItem"}
                      >
                        <details
                          style={{}}
                          className={"openapi-markdown__details"}
                        >
                          <summary
                            style={{}}
                          >
                            <span
                              className={"openapi-schema__container"}
                            >
                              <strong
                                className={"openapi-schema__property"}
                              >
                                preview
                              </strong><span
                                className={"openapi-schema__name"}
                              >
                                 object
                              </span><span
                                className={"openapi-schema__divider"}
                              >
                                
                              </span><span
                                className={"openapi-schema__required"}
                              >
                                required
                              </span>
                            </span>
                          </summary><div
                            style={{"marginLeft":"1rem"}}
                          >
                            <SchemaItem
                              name={"property name*"}
                              required={false}
                              schemaName={"any"}
                              qualifierMessage={undefined}
                              schema={{"type":"object","additionalProperties":{},"readOnly":true}}
                              collapsible={false}
                              discriminator={false}
                            >
                              
                            </SchemaItem>
                          </div>
                        </details>
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"preview\": {}\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"400"}
        value={"400"}
      >
        <div>
          
          
          Bad request
          
          
        </div><div>
          
        </div>
      </TabItem><TabItem
        label={"403"}
        value={"403"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"detail"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"detail\": \"string\",\n  \"code\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem>
    </ApiTabs>
  </div>
</div>