digitaluapi

<back to all web services

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.*


open class RegenerateApiKeyRequest
{
    /**
    * Environment type
    */
    @ApiMember(Description="Environment type")
    open var Environment:String? = null
}

@DataContract
open class RegenerateApiKeysResponse : IMeta
{
    @DataMember(Order=1)
    open var Results:ArrayList<UserApiKey>? = null

    @DataMember(Order=2)
    open var Meta:HashMap<String,String>? = null

    @DataMember(Order=3)
    open var ResponseStatus:ResponseStatus? = null
}

@DataContract
open class UserApiKey : IMeta
{
    @DataMember(Order=1)
    open var Key:String? = null

    @DataMember(Order=2)
    open var KeyType:String? = null

    @DataMember(Order=3)
    open var ExpiryDate:Date? = null

    @DataMember(Order=4)
    open var Meta:HashMap<String,String>? = null
}

Kotlin RegenerateApiKeyRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Environment: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Results: 
	[
		{
			Key: String,
			KeyType: String,
			ExpiryDate: 0001-01-01,
			Meta: 
			{
				String: String
			}
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}