Foundry API

CreateApiKeyRequest

The following routes are available for this service:
POST	/auth/apikey


export class PostOperationUnTenanted<TResponse> implements IPost
{

    public constructor(init?: Partial<PostOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}

export class ApiKey implements IIdentifiableResource
{
    public userId?: string;
    public description?: string;
    public expiresUtc?: string;
    public key?: string;
    public id?: string;

    public constructor(init?: Partial<ApiKey>) { (Object as any).assign(this, init); }
}

export class CreateApiKeyResponse
{
    public responseStatus?: ResponseStatus;
    public apiKey?: ApiKey;

    public constructor(init?: Partial<CreateApiKeyResponse>) { (Object as any).assign(this, init); }
}

export class CreateApiKeyRequest extends PostOperationUnTenanted<CreateApiKeyResponse>
{
    public description?: string;
    public expiresUtc?: string;

    public constructor(init?: Partial<CreateApiKeyRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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: staging-api.foundrylab.com 
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
	}
}