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}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel

Namespace Global

    Namespace digitaluapi.ServiceModel

        Public Partial Class RegenerateApiKeyRequest
            '''<Summary>
            '''Environment type
            '''</Summary>
            <ApiMember(Description:="Environment type")>
            Public Overridable Property Environment As String
        End Class
    End Namespace

    Namespace ServiceStack

        <DataContract>
        Public Partial Class RegenerateApiKeysResponse
            Implements IMeta
            <DataMember(Order:=1)>
            Public Overridable Property Results As List(Of UserApiKey)

            <DataMember(Order:=2)>
            Public Overridable Property Meta As Dictionary(Of String, String) Implements IMeta.Meta

            <DataMember(Order:=3)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        <DataContract>
        Public Partial Class UserApiKey
            Implements IMeta
            <DataMember(Order:=1)>
            Public Overridable Property Key As String

            <DataMember(Order:=2)>
            Public Overridable Property KeyType As String

            <DataMember(Order:=3)>
            Public Overridable Property ExpiryDate As Date?

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String) Implements IMeta.Meta
        End Class
    End Namespace
End Namespace

VB.NET 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
		}
	}
}