---
id: propertymappings-provider-scope-retrieve
title: "propertymappings_provider_scope_retrieve"
description: "ScopeMapping Viewset"
sidebar_label: "propertymappings_provider_scope_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytVt9v2zYQ/lcIvXQDDCtI+zD4acEaBAaWNWjSAkMRGLR0tlhTpEZSTj1D//u+I+VYsZ1kAfpgmBTv13f38XjbzDbkZFDWTMtskjWO92FTy6ZRZuln+LBWJbmZL3AycxScojVlo6wkXzjVsCoUb/n4OmmJr4oePAUINdLJmgI5n02+bTPFoo0MFY4MDnhXz9pWlfjgi4pqmU22Wdg0fOThyyxxsrCulgFfomR36PtCfPky/SiSuEC0JqjFhtehUl7E0EQf2xjmHP3TKkfAG1xL3f0oC3LJAR7Bz3DmqWidCpsIQLahYvMr7O5Z05FvrPHkOe7zszP+K6wJEOIl7GhVxPzm3z1Huz3GaeffqQgvp/SWnJJa/UuOs5rCVMlrs3o9ZxyoLD8ZvUmgAVkFzQo3tdhltZZGLjktx9ZMq7Wcs8JT7eukIuYbsU/NIZBPEZ9HNWQQ0pGoT2iNxV1FnoTthVmuQNABctKUom3KtG6DBTAkVesNK6HCCy2XwgKcUKbkdNPOmentiQLLOayvyT2gmqgPe6/VMpHfj8Xfto1SPiitRW1LcAhW9hGtlYz7i5vpSMzbIOhHE01X0izZoz30oIyQQiMc14c/5jQn4h/mGAewBzp5lWhydFzYGlTriXVYoKcZv6LQh/3Oi0c94W1KywOJlbEPosIPUVOpwgDpEVngG6Dm1tPsdOyH7j9TaJ3ZR/BE+xXrs0a3Tuq3O0l6r/pCN5IzVJf028Ao3GlnZGQGafGc+dQm/5/l1JhYVnBLIh/SneBSFFpxpQ973WsmP+53wqO8huvL9loPEj7gqoEOaFe4ceiFYroQmhZgct2EzWggaM27wGxWhvsIlSBuN2yc3wZsfELc4wT3hB9xn3qSnwNWnabB/b7XDPshwjl6BjhZH35qB/6KjltGVXHpnD1uvcaa2UKRLmfE535gUjonN1BQgWp/4j7HC12eagQ4kSWuJNxKfTP01+2TsQ8tRfZsPt7/xHxckcEzVHAHfCYhJYqvTlzeF9EOadUbGJS9d/oCzHSrK8sDzLIfOzBiTLL88D3Pd+NMHnmYb/vpo8uZmuTWu0GldZr1ZaPy9fs86wZzwC0nK6EdTAOPuKoQmt0ww/s54SVzMUi+TFGyRzZ8MdlzwnN+dv5h/Nv4/Cj713LFk8BOK9VQeFU3mnis4SLLIhYZ1eQqZBVpbX9f2v0rqyzXAgwgdIFI4TSGXU/vYCLBZgh+kudLFap2PsZNzwcm8v1qru08hyuT/zn94/Kv28sIs7E+4IUfGD8sg9iVQcQyiOemygFxnxsw+6wH+hHyRiMUhhdhbHsWnJjqImtjALuOhP/JfhJl+lVAwcrb7Vx6+uJ01/FntGnHoyCWa4mRLM5EIEypPK9BwYXUnl4A8svnnu6/ircOrifB7vqN4W6zlrrlHZYr2gzG6+4eohVeK2DmeNPpRVFQEwZ6R92Bmf94ua4umSRc/wHhe4KPdgu2fjImZDJK3NkVGWRzF2LgPQfYdf8BVVFowA==
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={"propertymappings_provider_scope_retrieve"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/propertymappings/provider/scope/{pm_uuid}/"}
>
  
</MethodEndpoint>



ScopeMapping Viewset

<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":"pm_uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this Scope Mapping.","required":true}}
      >
        
      </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={false}
                        name={"pk"}
                        required={true}
                        schemaName={"uuid"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","format":"uuid","readOnly":true,"title":"Pm uuid"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"managed"}
                        required={false}
                        schemaName={"Managed by authentik (string)"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","nullable":true,"title":"Managed by authentik","description":"Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update."}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"name"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"expression"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"component"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Get object's component so that we know how to edit the object","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"verbose_name"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Return object's verbose_name","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"verbose_name_plural"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Return object's plural verbose_name","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"meta_model_name"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Return internal model name","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"scope_name"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Scope name requested by the client"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"description"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Description shown to the user when consenting. If left empty, the user won't be informed."}}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"managed\": \"string\",\n  \"name\": \"string\",\n  \"expression\": \"string\",\n  \"component\": \"string\",\n  \"verbose_name\": \"string\",\n  \"verbose_name_plural\": \"string\",\n  \"meta_model_name\": \"string\",\n  \"scope_name\": \"string\",\n  \"description\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"400"}
        value={"400"}
      >
        <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={"non_field_errors"}
                        required={false}
                        schemaName={"string[]"}
                        qualifierMessage={undefined}
                        schema={{"type":"array","items":{"type":"string"}}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        name={"property name*"}
                        required={false}
                        schemaName={"any"}
                        qualifierMessage={undefined}
                        schema={{"type":"object","description":"Validation Error","properties":{"non_field_errors":{"type":"array","items":{"type":"string"}},"code":{"type":"string"}},"additionalProperties":{},"title":"ValidationError"}}
                        collapsible={false}
                        discriminator={false}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"non_field_errors\": [\n    \"string\"\n  ],\n  \"code\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </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>