> For the complete documentation index, see [llms.txt](https://docs.veza.com/4yItIzMvkpAvMVFAamTf/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.veza.com/4yItIzMvkpAvMVFAamTf/developers/api/oaa/best-practices/sourcing-and-extracting-metadata.md). # Sourcing and Extracting Metadata Strategies for extracting authorization, identity, and resource metadata When planning an OAA connector, consider how you will gather the information you want to import into Veza. Refer to the application’s documentation to confirm you can obtain the required metadata from the host application. Ideally, you will be able to list and collect metadata for: * User records * Group memberships * User roles and permissions * Resource names and metadata For example, the Veza-GitHub connector utilizes the following endpoints (in addition to basic authentication and authorization APIs): {% code overflow="wrap" %} ```markup - orgs/{org_name} - Get Organization information - orgs/{org_name}/members - List members for an organization - orgs/{org_name}/teams - List teams for an organization - orgs/{org_name}/teams/{team}/members - List members for a given team - orgs/{org_name}/repos - List organization repositories - repos/{org_name}/{repo}/teams - List Team permissions for repository - repos/{org_name}/{repo}/collaborators?affiliation=direct - List team members with direct permissions ``` {% endcode %} Web-based APIs are a common solution for SaaS apps, but not required for an OAA integration. Just because an endpoint exists does not mean that it returns useful information (some APIs are more designed for client automation than audits). Possible choices for sourcing metadata include: * From a database: Is data for a hosted app available in a database your connector can query? * File-based extraction: is the metadata available in source code or a configuration file, or an exportable report (such as CSV)? * Other options: does the provider have an SDK or CLI interface you can use to retrieve data? If no machine-readable data is readily available, even screen scraping could be a solution. There are many creative options for extracting the information to populate the template, although an API will typically be the most usable option. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.veza.com/4yItIzMvkpAvMVFAamTf/developers/api/oaa/best-practices/sourcing-and-extracting-metadata.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.