components:
  schemas:
    AccountService_v1_5_0_AccountProviderTypes:
      enum:
      - RedfishService
      - ActiveDirectoryService
      - LDAPService
      - OEM
      type: string
      x-enumDescriptions:
        ActiveDirectoryService: An external Active Directory Service.
        LDAPService: A generic external LDAP Service.
        OEM: An OEM specific external authentication or directory service.
        RedfishService: An external Redfish Service.
      x-enumLongDescriptions:
        ActiveDirectoryService: The external account provider shall be a service conforming
          to the Microsoft Active Directory Technical specification. The format of
          ServiceAddresses shall be a collection of FQDNs or Netbios names that references
          the set of domain servers for the Active Directory service.
        LDAPService: The external account provider shall be a service conforming to
          RFC4511. The format of ServiceAddresses shall be a collection of FQDNs that
          references the set of LDAP servers for the service.
        RedfishService: The external account provider shall be a service conforming
          to the DMTF Redfish specification. The format of ServiceAddresses shall
          be a collection of URIs which corresponds to a Redfish AccountService entity.
    AccountService_v1_5_0_AccountService:
      additionalProperties: false
      description: The AccountService schema contains properties for managing user
        accounts. The properties are common to all user accounts, such as password
        requirements, and control features such as account lockout. The schema also
        contains links to the collections of Manager Accounts and Roles.
      properties:
        '@odata.context':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_context
        '@odata.etag':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_etag
        '@odata.id':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_id
        '@odata.type':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_type
        AccountLockoutCounterResetAfter:
          description: The interval of time in seconds between the last failed login
            attempt and reset of the lockout threshold counter. This value must be
            less than or equal to AccountLockoutDuration. Reset sets the counter to
            zero.
          minimum: 0
          readOnly: false
          type: integer
          x-longDescription: This property shall reference the threshold of time in
            seconds from the last failed login attempt at which point the AccountLockoutThreshold
            counter (that counts number of failed login attempts) is reset back to
            zero (at which point AccountLockoutThreshold failures would be required
            before the account is locked).  This value shall be less than or equal
            to AccountLockoutDuration. The threshold counter also resets to zero after
            each successful login.  If AccountLockoutCounterResetEnabled is set to
            false, the value of this property will be ignored.
          x-units: s
        AccountLockoutCounterResetEnabled:
          description: The value indicates whether the threshold counter will be reset
            after AccountLockoutCounterResetAfter expires.
          readOnly: false
          type: boolean
          x-longDescription: This property shall indicate whether the threshold counter
            will be reset after the AccountLockoutCounterResetAfter has expired.  Setting
            the value to false shall indicate that only a successful login will reset
            the threshold counter.  In addition, if the user reaches the limit specified
            in AccountLockoutThreshold, the account shall be locked out indefinitely
            and only a reset by administrator will clear the threshold counter.  If
            this property is absent the value shall be assumed to be true.
          x-versionAdded: v1_5_0
        AccountLockoutDuration:
          description: The time in seconds an account is locked out. The value must
            be greater than or equal to the value of the AccountLockoutCounterResetAfter
            property. If set to 0, no lockout occurs.
          minimum: 0
          nullable: true
          readOnly: false
          type: integer
          x-longDescription: This property shall reference the period of time in seconds
            that an account is locked after the number of failed login attempts reaches
            the threshold referenced by AccountLockoutThreshold, within the window
            of time referenced by AccountLockoutCounterResetAfter.  The value shall
            be greater than or equal to the value of AccountLockoutResetAfter.  If
            set to 0, no lockout shall occur.  If AccountLockoutCounterResetEnabled
            is set to false, the value of this property will be ignored.
          x-units: s
        AccountLockoutThreshold:
          description: The number of failed login attempts allowed before a user account
            is locked for a specified duration. A value of 0 means it is never locked.
          minimum: 0
          nullable: true
          readOnly: false
          type: integer
          x-longDescription: This property shall reference the threshold of failed
            login attempts at which point the user's account is locked.  If set to
            0, no lockout shall ever occur.
        Accounts:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: A link to a collection of Manager Accounts.
          readOnly: true
          x-longDescription: This property shall contain the link to a collection
            of type ManagerAccountCollection.
        Actions:
          $ref: '#/components/schemas/AccountService_v1_5_0_Actions'
          description: The available actions for this resource.
          x-longDescription: The Actions property shall contain the available actions
            for this resource.
          x-versionAdded: v1_2_0
        ActiveDirectory:
          $ref: '#/components/schemas/AccountService_v1_5_0_ExternalAccountProvider'
          description: The first ActiveDirectory external account provider this AccountService
            supports.
          x-longDescription: This property shall contain the first ActiveDirectory
            external account provider this AccountService supports. If the AccountService
            supports 1 or more ActiveDirectory services as an external account provider
            this entity must be populated by default. This entity shall not be present
            in the AdditionalExternalAccountProviders collection.
          x-versionAdded: v1_3_0
        AdditionalExternalAccountProviders:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The additional external account providers this AccountService
            is using.
          readOnly: true
          x-longDescription: This property shall contain an additional external account
            providers this AccountService is using.
          x-versionAdded: v1_3_0
        AuthFailureLoggingThreshold:
          description: The number of authorization failures allowed before the failure
            attempt is logged to the manager log.
          minimum: 0
          readOnly: false
          type: integer
          x-longDescription: This property shall reference the threshold for when
            an authorization failure is logged.  This represents a modulo function
            value, thus the failure shall be logged every nth occurrence where n represents
            the value of this property.
        Description:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Description
          nullable: true
          readOnly: true
        Id:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Id
          readOnly: true
        LDAP:
          $ref: '#/components/schemas/AccountService_v1_5_0_ExternalAccountProvider'
          description: The first LDAP external account provider this AccountService
            supports.
          x-longDescription: This property shall contain the first LDAP external account
            provider this AccountService supports. If the AccountService supports
            1 or more LDAP services as an external account provider this entity must
            be populated by default. This entity shall not be present in the AdditionalExternalAccountProviders
            collection.
          x-versionAdded: v1_3_0
        LocalAccountAuth:
          $ref: '#/components/schemas/AccountService_v1_5_0_LocalAccountAuth'
          description: Controls when this service will use the accounts defined withing
            this AccountService as part of authentication.
          readOnly: false
          x-longDescription: This property shall govern how the service uses the Accounts
            collection within this AccountService as part of authentication.  Details
            about each of the modes are found in the description of the enum values.
          x-versionAdded: v1_3_0
        MaxPasswordLength:
          description: The maximum password length for this service.
          minimum: 0
          readOnly: true
          type: integer
          x-longDescription: This property shall reference the maximum password length
            that the implementation will allow a password to be set to.
        MinPasswordLength:
          description: The minimum password length for this service.
          minimum: 0
          readOnly: true
          type: integer
          x-longDescription: This property shall reference the minimum password length
            that the implementation will allow a password to be set to.
        Name:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Name
          readOnly: true
        Oem:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem
          description: This is the manufacturer/provider specific extension moniker
            used to divide the Oem object into sections.
          x-longDescription: The value of this string shall be of the format for the
            reserved word *Oem*.
        PrivilegeMap:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: A reference to the Privilege mapping that defines the privileges
            needed to perform a requested operation on a URI associated with this
            service.
          readOnly: true
          x-longDescription: The value of this property shall be a link to a resource
            of type PrivilegeMappoing that defines the privileges a user context needs
            in order to perform a requested operation on a URI associated with this
            service.
          x-versionAdded: v1_1_0
        Roles:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: A link to a collection of Roles.
          readOnly: true
          x-longDescription: This property shall contain the link to a collection
            of type RoleCollection.
        ServiceEnabled:
          description: Indicates whether this service is enabled.  If set to false,
            the AccountService is disabled.  This means no users can be created, deleted
            or modified.  Any service attempting to access the AccountService resource
            (for example, the Session Service) will fail.  New sessions cannot be
            started when the service is disabled. However, established sessions may
            still continue operating. This does not affect Basic AUTH connections.
          nullable: true
          readOnly: false
          type: boolean
          x-longDescription: 'The value of this property shall be a boolean indicating
            whether this service is enabled.  If this is set to false, the AccountService
            is disabled.  This means no users can be created, deleted or modified.  Any
            service attempting to access the Account Service, like the Session Service,
            will fail accessing.  Thus new sessions cannot be started with the service
            disabled (though established sessions may still continue operating).  Note:
            this does not affect Basic AUTH connections.'
        Status:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Status
          description: This property describes the status and health of the resource
            and its children.
          x-longDescription: This property shall contain any status or health properties
            of the resource.
      required:
      - '@odata.id'
      - '@odata.type'
      - Id
      - Name
      type: object
      x-longDescription: This resource shall be used to represent a management account
        service for a Redfish implementation.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    AccountService_v1_5_0_Actions:
      additionalProperties: false
      description: The available actions for this resource.
      properties:
        Oem:
          $ref: '#/components/schemas/AccountService_v1_5_0_OemActions'
          description: This property contains the available OEM specific actions for
            this resource.
          x-longDescription: This property shall contain any additional OEM actions
            for this resource.
          x-versionAdded: v1_2_0
      type: object
      x-longDescription: This type shall contain the available actions for this resource.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    AccountService_v1_5_0_Authentication:
      additionalProperties: false
      description: Contains the authentication information for the external service.
      properties:
        AuthenticationType:
          $ref: '#/components/schemas/AccountService_v1_5_0_AuthenticationTypes'
          description: This property contains the type of authentication used to connect
            to the external account provider.
          nullable: true
          readOnly: false
          x-longDescription: The value of this property shall be the type of authentication
            used to connect to the external account provider.
          x-versionAdded: v1_3_0
        KerberosKeytab:
          description: This property is used with a PATCH or PUT to write a base64
            encoded version of the kerberos keytab for the account.  This property
            is null on a GET.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: The value of this property shall be a base64 encoded
            version of the kerberos keytab for this account service.  The value shall
            be null for GET requests.
          x-versionAdded: v1_3_0
        Oem:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem
          description: Oem extension object.
          x-longDescription: This object represents the Oem property.  All values
            for resources described by this schema shall comply to the requirements
            as described in the Redfish specification.
          x-versionAdded: v1_3_0
        Password:
          description: This property is used with a PATCH or PUT to write the password
            for the account service.  This property is null on a GET.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: The value of this property shall be the password for
            this account service.  The value shall be null for GET requests.
          x-versionAdded: v1_3_0
        Token:
          description: This property is used with a PATCH or PUT to write the token
            for the account.  This property is null on a GET.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: The value of this property shall be the token for this
            account service.  The value shall be null for GET requests.
          x-versionAdded: v1_3_0
        Username:
          description: This property contains the user name for the account service.
          readOnly: false
          type: string
          x-longDescription: The value of this property shall be the user name for
            this account service.
          x-versionAdded: v1_3_0
      type: object
      x-longDescription: This type shall contain all the required information to authenticate
        to the external service.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    AccountService_v1_5_0_AuthenticationTypes:
      enum:
      - Token
      - KerberosKeytab
      - UsernameAndPassword
      - OEM
      type: string
      x-enumDescriptions:
        KerberosKeytab: A kerberos keytab.
        OEM: An OEM specific authentication mechanism.
        Token: An opaque authentication token.
        UsernameAndPassword: Username and password combination.
    AccountService_v1_5_0_ExternalAccountProvider:
      additionalProperties: false
      description: A remote service that can provide accounts for this manager to
        utilize for authentication.
      properties:
        AccountProviderType:
          $ref: '#/components/schemas/AccountService_v1_5_0_AccountProviderTypes'
          deprecated: true
          description: This property contains the type of external account provider
            this resource references.
          nullable: true
          readOnly: true
          x-deprecatedReason: This property has been Deprecated as the Account Provider
            type is known when used in the LDAP and ActiveDirectory objects.
          x-longDescription: The value of this property shall be the type of external
            account provider referenced by this resource.
          x-versionAdded: v1_3_0
          x-versionDeprecated: v1_5_0
        Authentication:
          $ref: '#/components/schemas/AccountService_v1_5_0_Authentication'
          description: This property contains the authentication information for the
            external account provider.
          x-longDescription: The value of this property shall contain the authentication
            information for the external account provider.
          x-versionAdded: v1_3_0
        Certificates:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: This is a reference to a collection of certificates used for
            the external account provider.
          readOnly: true
          x-longDescription: The value of this property shall be a link to a collection
            of type CertificateCollection.
          x-versionAdded: v1_4_0
        LDAPService:
          $ref: '#/components/schemas/AccountService_v1_5_0_LDAPService'
          description: This property contains additional mapping information needed
            to parse a generic LDAP service.
          x-longDescription: The value of this property shall contain any additional
            mapping information needed to parse a generic LDAP service.
          x-versionAdded: v1_3_0
        RemoteRoleMapping:
          description: This property contains a collection of the mapping rules to
            convert the external account providers account information to the local
            Redfish Role.
          items:
            $ref: '#/components/schemas/AccountService_v1_5_0_RoleMapping'
            nullable: true
          type: array
          x-longDescription: This property shall contain a collection of the mapping
            rules to convert the external account providers account information to
            the local Redfish Role.
          x-versionAdded: v1_3_0
        ServiceAddresses:
          description: This property contains the addresses of the user account providers
            this resource references. The format of this field depends on the Type.
          items:
            nullable: true
            type: string
          readOnly: false
          type: array
          x-longDescription: The value of this property shall be the addresses of
            the account providers this resource references. The format of this field
            depends on the Type of the ExternalAccountProvider. Each item in the array
            shall contain a single address. Services may define their own behavior
            for managing multiple addresses.
          x-versionAdded: v1_3_0
        ServiceEnabled:
          description: This indicates whether this service is enabled.
          nullable: true
          readOnly: false
          type: boolean
          x-longDescription: The value of this property shall be a boolean indicating
            whether this service is enabled.
          x-versionAdded: v1_3_0
      type: object
      x-longDescription: This type shall be used to represent resources that represent
        external user account services for this manager.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    AccountService_v1_5_0_LDAPSearchSettings:
      additionalProperties: false
      description: Contains settings for searching a generic LDAP service.
      properties:
        BaseDistinguishedNames:
          description: The base distinguished names to use when searching the LDAP
            service.
          items:
            nullable: true
            type: string
          readOnly: false
          type: array
          x-longDescription: The value of this property shall be a collection of base
            distinguished names to use when searching the LDAP service.
          x-versionAdded: v1_3_0
        GroupNameAttribute:
          description: The attribute name that contains the name of the Group on the
            group LDAP entry.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: The value of this property shall be the attribute name
            that contains the name of the Group.
          x-versionAdded: v1_3_0
        GroupsAttribute:
          description: The attribute name that contains the Groups for a user on the
            user LDAP entry.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: The value of this property shall be the attribute name
            that contains the Groups for a user.
          x-versionAdded: v1_3_0
        UsernameAttribute:
          description: The attribute name that contains the Username on the user LDAP
            entry.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: The value of this property shall be the attribute name
            that contains the Username.
          x-versionAdded: v1_3_0
      type: object
      x-longDescription: This type shall contain all the required settings for searching
        a generic LDAP service.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    AccountService_v1_5_0_LDAPService:
      additionalProperties: false
      description: Contains settings for parsing a generic LDAP service.
      properties:
        Oem:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem
          description: Oem extension object.
          x-longDescription: This object represents the Oem property.  All values
            for resources described by this schema shall comply to the requirements
            as described in the Redfish specification.
          x-versionAdded: v1_3_0
        SearchSettings:
          $ref: '#/components/schemas/AccountService_v1_5_0_LDAPSearchSettings'
          description: This property contains the settings needed to search an external
            LDAP service.
          x-longDescription: The value of this property shall contain the settings
            needed to search an external LDAP service.
          x-versionAdded: v1_3_0
      type: object
      x-longDescription: This type shall contain all the required settings for parsing
        a generic LDAP service.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    AccountService_v1_5_0_LocalAccountAuth:
      enum:
      - Enabled
      - Disabled
      - Fallback
      type: string
      x-enumDescriptions:
        Disabled: Authentication via accounts defined in this AccountService is disabled.
        Enabled: Authentication via accounts defined in this AccountService is enabled.
        Fallback: Authentication via accounts defined in this AccountService is only
          used if there are external account providers that are currently unreachable.
      x-enumLongDescriptions:
        Disabled: This value shall be used to indicate that the service will never
          authenticate users based on the Accounts collection within this AccountService.
        Enabled: This value shall be used to indicate that the service will authenticate
          users based on the Accounts collection within this AccountService.
        Fallback: This value shall be used to indicate that the service will authenticate
          users based on the Accounts collection within this AccountService only if
          there are external account providers that are currently unreachable.
    AccountService_v1_5_0_OemActions:
      additionalProperties: true
      description: The available OEM specific actions for this resource.
      properties: {}
      type: object
      x-longDescription: This type shall contain any additional OEM actions for this
        resource.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    AccountService_v1_5_0_RoleMapping:
      additionalProperties: false
      description: Contains mapping rules to convert the external account providers
        account information to the local Redfish Role.
      properties:
        LocalRole:
          description: The name of the local role in which to map the remote user
            or group.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: The value of this property shall contain the value of
            the RoleId property within a Role resource on this Redfish service in
            which to map the remote user or group.
          x-versionAdded: v1_3_0
        Oem:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem
          description: Oem extension object.
          x-longDescription: This object represents the Oem property.  All values
            for resources described by this schema shall comply to the requirements
            as described in the Redfish specification.
          x-versionAdded: v1_3_0
        RemoteGroup:
          description: This property is the name of the remote group (or in the case
            of a Redfish Service, remote role) that will be mapped to the local role
            referenced by this entity.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: The value of this property shall contain the name of
            the remote group (or in the case of a Redfish Service, remote role) that
            will be mapped to the local role referenced by this entity.
          x-versionAdded: v1_3_0
        RemoteUser:
          description: This property is the name of the remote user that will be mapped
            to the local role referenced by this entity.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: The value of this property shall contain the name of
            the remote user that will be mapped to the local role referenced by this
            entity.
          x-versionAdded: v1_3_0
      type: object
      x-longDescription: This type shall contain mapping rules to convert the external
        account providers account information to the local Redfish Role.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
title: '#AccountService.v1_5_0.AccountService'
x-copyright: Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright
x-owningEntity: DMTF
x-release: '2019.1'
