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}

"use strict";
export class UserApiKey {
    /** @param {{Key?:string,KeyType?:string,ExpiryDate?:string,Meta?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    KeyType;
    /** @type {?string} */
    ExpiryDate;
    /** @type {{ [index:string]: string; }} */
    Meta;
}
export class RegenerateApiKeysResponse {
    /** @param {{Results?:UserApiKey[],Meta?:{ [index:string]: string; },ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {UserApiKey[]} */
    Results;
    /** @type {{ [index:string]: string; }} */
    Meta;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class RegenerateApiKeyRequest {
    /** @param {{Environment?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Environment type */
    Environment;
}

JavaScript 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
		}
	}
}