Foundry API

<back to all web services

CreateApiKeyRequest

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

namespace Application.Interfaces.Resources
{
    public partial class ApiKey
        : IIdentifiableResource
    {
        public virtual string UserId { get; set; }
        public virtual string Description { get; set; }
        public virtual DateTime? ExpiresUtc { get; set; }
        public virtual string Key { get; set; }
        public virtual string Id { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class PostOperationUnTenanted<TResponse>
        : IPost
    {
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.IdentityProvider
{
    public partial class CreateApiKeyRequest
        : PostOperationUnTenanted<CreateApiKeyResponse>
    {
        public virtual string Description { get; set; }
        public virtual DateTime? ExpiresUtc { get; set; }
    }

    public partial class CreateApiKeyResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual ApiKey ApiKey { get; set; }
    }

}

C# 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
	}
}