Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
Loading...
Searching...
No Matches
tenant_information.h
Go to the documentation of this file.
1/*
2 *
3 * Copyright (c) Microsoft Corporation.
4 * All rights reserved.
5 *
6 * This code is licensed under the MIT License.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files(the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions :
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 *
26 */
27/**
28 * @brief Defines TenantInformation interface
29 *
30 * @file tenant_information.h
31 */
32
33#ifndef API_MIP_PROTECTION_TENANT_INFORMATION_H_
34#define API_MIP_PROTECTION_TENANT_INFORMATION_H_
35
36#include <memory>
37#include <string>
38
39#include "mip/mip_namespace.h"
40
41MIP_NAMESPACE_BEGIN
42
43/**
44 * @brief Tenant information from RMS
45 */
47public:
48 /**
49 * @brief Get the issuer name
50 *
51 * @return The display name for the organization associated with this tenant
52 */
53 virtual const std::string& GetIssuerName() const = 0;
54 /**
55 * @brief Get the extranet Url of tenant
56 *
57 * @return The URL used to obtain licenses for content outside an enterprise's intranet
58 */
59 virtual const std::string& GetExtranetUrl() const = 0;
60 /**
61 * @brief Get intranet Url of tenant (Expected to match extranet url outside of ADRMS scenarios)
62 *
63 * @return The URL used to obtain licenses for content within an enterprise's intranet.
64 * Same as extranet url for tenants that use Azure RMS.
65 */
66 virtual const std::string& GetIntranetUrl() const = 0;
67
68 /**
69 * @brief Get Id of Tenant if applicable
70 *
71 * @return The unique id used to refer to this tenant
72 */
73 virtual const std::string& GetTenantId() const = 0;
74
75 /** @cond DOXYGEN_HIDE */
76 virtual ~TenantInformation() {}
77protected:
79 /** @endcond */
80};
81
82MIP_NAMESPACE_END
83
84#endif // API_MIP_PROTECTION_TENANT_INFORMATION_H_
Tenant information from RMS.
virtual const std::string & GetExtranetUrl() const =0
Get the extranet Url of tenant.
virtual const std::string & GetTenantId() const =0
Get Id of Tenant if applicable.
virtual const std::string & GetIssuerName() const =0
Get the issuer name.
virtual const std::string & GetIntranetUrl() const =0
Get intranet Url of tenant (Expected to match extranet url outside of ADRMS scenarios)
MIP namespace macros.