Skip to main content
Sign Out

Welcome to Dell

My Account
  • Place orders quickly and easily
  • View orders and track your shipping status
  • Enjoy members-only rewards and discounts
  • Create and access a list of your products
  • Manage your Dell EMC sites, products, and product-level contacts using Company Administration.
Sign In Create an Account Dell Financial Services Premier Sign In Partner Program Sign In
Contact Us

Your Dell.com Carts

iDRAC9 Redfish API Guide Firmware version: 4.20.20.20

PDF

Delegated Authority

Supported Methods

Delegated Auth allows iDRAC to delegate user management to a remote Authorization Server. Once configured, iDRAC accepts OAuth 2.0 specification compliant JSON Web Tokens (JWT) that are issued by the server. These tokens can be used in place of the basic authorization header in Redfish HTTP requests. Following table describes the operations that are supported through iDRAC Redfish API:
Method Description URI Payload
GET Get all Delegated Authority instances. /redfish/v1/AccountService/ExternalAccountProviders N/A
POST Create a new Delegated Authority instance. /redfish/v1/AccountService/ExternalAccountProviders 
{​​​
  "AccountProviderType": "OEM",
  "Oem": {​​​​​​​​​​
    "Dell": {​​​​​​​​​​
      "OAuthConfig": {​​​​​​​​​​
        "HttpsCertificate": "HttpsCertificate",
        "ServerURL": "ServerURL",
        "NameTag": "URL_SAFE_NAME",
        "PublicSigningKey": "PublicSigningKey",
        "Issuer": "Issuer"
      }​​​​​​​​​​
    }​​​​​​​​​​
  }​​​​​​​​​​
}​​​​​​​​​​
​​​​​​​​​​Along with the NameTag, you must provide a complete online configuration or an offline configuration or both to create an instance successfully.
GET Get a Delegated Authority instance. /redfish/v1/AccountService/ExternalAccountProviders/{​​​​​​​​​​NameTag Attribute Value}​​​​​​​​​​ None
DELETE Delete a Delegated Authority instance. /redfish/v1/AccountService/ExternalAccountProviders/{​​​​​​​​​​NameTag Attribute Value}​​​​​​​​​​ None
PATCH Update a Delegated Authority instance. /redfish/v1/AccountService/ExternalAccountProviders/{​​​​​​​​​​NameTag Attribute Value}​​​​​​​​​​ 
{​​​​​​​​​​
  "Oem": {​​​​​​​​​​
    "Dell": {​​​​​​​​​​
      "OAuthConfig": {​​​​​​​​​​
        "HttpsCertificate": "HttpsCertificate",
        "ServerURL": "ServerURL",
        "NameTag": "URL_SAFE_NAME",
        "PublicSigningKey": "PublicSigningKey",
        "Issuer": "Issuer"
      }​​​​​​​​​​
    }​​​​​​​​​​
  }​​​​​​​​​​
}​​​​​​​​​​
You can set any number of Attributes(0-5) in one go.
NOTE Updating the NameTag value, will also change the URI.
POST Test a Token. /redfish/v1/AccountService/ExternalAccountProviders/{​​​​​​​​​​ExternalAccountProviderId}​​​​​​​​​​/Actions/Oem/DellOAuthConfig.SubmitTestToken 
{​​​​​​​​​​
"Token":"YOUR TEST TOKEN",
"ForceDownload": false
}​​​​​​​​​​
Token is required and ForceDownload is optional and is set to false by default.

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\