Foundry API

<back to all web services

CreateApiKeyRequest

Requires Authentication
The following routes are available for this service:
POST/auth/apikey
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Infrastructure.Api.Interfaces.ServiceOperations.IdentityProvider
Imports Infrastructure.Api.Interfaces.ServiceOperations
Imports Application.Interfaces.Resources

Namespace Global

    Namespace Application.Interfaces.Resources

        Public Partial Class ApiKey
            Implements IIdentifiableResource
            Public Overridable Property UserId As String
            Public Overridable Property Description As String
            Public Overridable Property ExpiresUtc As Nullable(Of Date)
            Public Overridable Property Key As String
            Public Overridable Property Id As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations

        Public Partial Class PostOperationUnTenanted(Of TResponse)
            Implements IPost
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.IdentityProvider

        Public Partial Class CreateApiKeyRequest
            Inherits PostOperationUnTenanted(Of CreateApiKeyResponse)
            Public Overridable Property Description As String
            Public Overridable Property ExpiresUtc As Nullable(Of Date)
        End Class

        Public Partial Class CreateApiKeyResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property ApiKey As ApiKey
        End Class
    End Namespace
End Namespace

VB.NET CreateApiKeyRequest 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/apikey HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	apiKey: 
	{
		userId: String,
		description: String,
		expiresUtc: ,
		key: String,
		id: String
	}
}