xref: /openbmc/bmcweb/redfish-core/schema/dmtf/csdl/Privileges_v1.xml (revision f2a8e57e)

<?xml version="1.0" encoding="UTF-8"?>
<!---->
<!--################################################################################       -->
<!--# Redfish Schema:  Privileges v1.0.6                                                   -->
<!--#                                                                                      -->
<!--# For a detailed change log, see the README file contained in the DSP8010 bundle,      -->
<!--# available at http://www.dmtf.org/standards/redfish                                   -->
<!--# Copyright 2014-2024 DMTF.                                                            -->
<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
<!--################################################################################       -->
<!---->
<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">

  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
    <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
    <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
  </edmx:Reference>

  <edmx:DataServices>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Privileges">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Language" String="en"/>

      <EnumType Name="PrivilegeType">
        <Member Name="Login">
          <Annotation Term="OData.Description" String="Can log in to the service and read resources."/>
        </Member>
        <Member Name="ConfigureManager">
          <Annotation Term="OData.Description" String="Can configure managers."/>
        </Member>
        <Member Name="ConfigureUsers">
          <Annotation Term="OData.Description" String="Can configure users and their accounts."/>
        </Member>
        <Member Name="ConfigureSelf">
          <Annotation Term="OData.Description" String="Can change the password for the current user account, log out of their own sessions, and perform operations on resources they created.  Services will need to be aware of resource ownership to map this privilege to an operation from a particular user."/>
        </Member>
        <Member Name="ConfigureComponents">
          <Annotation Term="OData.Description" String="Can configure components that this service manages."/>
        </Member>
        <Member Name="NoAuth">
          <Annotation Term="OData.Description" String="Authentication is not required."/>
          <Annotation Term="OData.LongDescription" String="This value shall be used to indicate an operation does not require authentication.  This privilege shall not be used in Redfish roles."/>
          <Annotation Term="Redfish.Revisions">
            <Collection>
              <Record>
                <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
                <PropertyValue Property="Version" String="2019.3"/>
              </Record>
            </Collection>
          </Annotation>
        </Member>
        <Member Name="ConfigureCompositionInfrastructure">
          <Annotation Term="OData.Description" String="Can view and configure composition service resources."/>
          <Annotation Term="OData.LongDescription" String="This value shall be used to indicate the user can view and configure composition service resources without matching the `Client` property in the `ResourceBlock` or `CompositionReservation` resources."/>
          <Annotation Term="Redfish.Revisions">
            <Collection>
              <Record>
                <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
                <PropertyValue Property="Version" String="2021.1"/>
              </Record>
            </Collection>
          </Annotation>
        </Member>
        <Member Name="AdministrateSystems">
          <Annotation Term="OData.Description" String="Administrator for systems found in the systems collection.  Able to manage boot configuration, keys, and certificates for systems."/>
          <Annotation Term="Redfish.Revisions">
            <Collection>
              <Record>
                <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
                <PropertyValue Property="Version" String="2022.2"/>
              </Record>
            </Collection>
          </Annotation>
        </Member>
        <Member Name="OperateSystems">
          <Annotation Term="OData.Description" String="Operator for systems found in the systems collection.  Able to perform resets and configure interfaces."/>
          <Annotation Term="Redfish.Revisions">
            <Collection>
              <Record>
                <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
                <PropertyValue Property="Version" String="2022.2"/>
              </Record>
            </Collection>
          </Annotation>
        </Member>
        <Member Name="AdministrateStorage">
          <Annotation Term="OData.Description" String="Administrator for storage subsystems and storage systems found in the storage collection and storage system collection respectively."/>
          <Annotation Term="Redfish.Revisions">
            <Collection>
              <Record>
                <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
                <PropertyValue Property="Version" String="2022.2"/>
              </Record>
            </Collection>
          </Annotation>
        </Member>
        <Member Name="OperateStorageBackup">
          <Annotation Term="OData.Description" String="Operator for storage backup functionality for storage subsystems and storage systems found in the storage collection and storage system collection respectively."/>
          <Annotation Term="Redfish.Revisions">
            <Collection>
              <Record>
                <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
                <PropertyValue Property="Version" String="2022.2"/>
              </Record>
            </Collection>
          </Annotation>
        </Member>
      </EnumType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Privileges.v1_0_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="1.0"/>

      <Term Name="OemGetPrivileges" Type="Collection(Edm.String)" Nullable="false">
        <Annotation Term="OData.Description" String="OEM HTTP `GET` operation privileges might be defined on a `Link` element to provide read privileges for the referenced resources, or on individual elements to override the privileges for that element."/>
      </Term>
      <Term Name="OemPostPrivileges" Type="Collection(Edm.String)" Nullable="false">
        <Annotation Term="OData.Description" String="OEM HTTP `POST` operation privileges might be defined on a `Link` element to provide create privileges for the referenced resources, or on individual elements to override the privileges for that element."/>
      </Term>
      <Term Name="OemPatchPutPrivileges" Type="Collection(Edm.String)" Nullable="false">
        <Annotation Term="OData.Description" String="OEM HTTP `PATCH`/`PUT` operation privileges might be defined on a `Link` element to provide update privileges for the referenced resources, or on individual elements to override the privileges for that element."/>
      </Term>
      <Term Name="OemDeletePrivileges" Type="Collection(Edm.String)" Nullable="false">
        <Annotation Term="OData.Description" String="OEM HTTP `DELETE` operation privileges might be defined on a `Link` element to provide update privileges for the referenced resources, or on individual elements to override the privileges for that element."/>
      </Term>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Privileges.v1_0_2">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to show that annotations in previous namespaces were updated."/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Privileges.v1_0_3">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to show that annotations in previous namespaces were updated."/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Privileges.v1_0_4">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version deprecates the versioned PrivilegeType definition to use an unversioned definition."/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Privileges.v1_0_5">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Privileges.v1_0_6">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to force the regeneration of OpenAPI schemas to properly express nullable properties with external references.  It was also created to correct various typographical errors."/>
    </Schema>

  </edmx:DataServices>
</edmx:Edmx>