digitaluapi

RegenerateApiKeyRequest

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
POST	/auth/apikeys/regenerate
POST	/auth/apikeys/regenerate/{Environment}

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class RegenerateApiKeyRequest
    {
        /**
        * Environment type
        */
        @ApiMember(Description="Environment type")
        public String Environment = null;
        
        public String getEnvironment() { return Environment; }
        public RegenerateApiKeyRequest setEnvironment(String value) { this.Environment = value; return this; }
    }

    @DataContract
    public static class RegenerateApiKeysResponse implements IMeta
    {
        @DataMember(Order=1)
        public ArrayList<UserApiKey> Results = null;

        @DataMember(Order=2)
        public HashMap<String,String> Meta = null;

        @DataMember(Order=3)
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<UserApiKey> getResults() { return Results; }
        public RegenerateApiKeysResponse setResults(ArrayList<UserApiKey> value) { this.Results = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public RegenerateApiKeysResponse setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public RegenerateApiKeysResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    @DataContract
    public static class UserApiKey implements IMeta
    {
        @DataMember(Order=1)
        public String Key = null;

        @DataMember(Order=2)
        public String KeyType = null;

        @DataMember(Order=3)
        public Date ExpiryDate = null;

        @DataMember(Order=4)
        public HashMap<String,String> Meta = null;
        
        public String getKey() { return Key; }
        public UserApiKey setKey(String value) { this.Key = value; return this; }
        public String getKeyType() { return KeyType; }
        public UserApiKey setKeyType(String value) { this.KeyType = value; return this; }
        public Date getExpiryDate() { return ExpiryDate; }
        public UserApiKey setExpiryDate(Date value) { this.ExpiryDate = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public UserApiKey setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
    }

}

Java RegenerateApiKeyRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /auth/apikeys/regenerate HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RegenerateApiKeyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Environment>String</Environment>
</RegenerateApiKeyRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegenerateApiKeysResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Results>
    <UserApiKey>
      <Key>String</Key>
      <KeyType>String</KeyType>
      <ExpiryDate>0001-01-01T00:00:00</ExpiryDate>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </UserApiKey>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</RegenerateApiKeysResponse>