Foundry API

<back to all web services

CreateApiKeyRequest

Requires Authentication
The following routes are available for this service:
POST/auth/apikey
namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiKey() = 
        member val UserId:String = null with get,set
        member val Description:String = null with get,set
        member val ExpiresUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Key:String = null with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type CreateApiKeyResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val ApiKey:ApiKey = null with get,set

    [<AllowNullLiteral>]
    type CreateApiKeyRequest() = 
        inherit PostOperationUnTenanted<CreateApiKeyResponse>()
        member val Description:String = null with get,set
        member val ExpiresUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type PostOperationUnTenanted<'TResponse>() = 
        interface IPost

F# CreateApiKeyRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"description":"String","expiresUtc":null}

HTTP/1.1 200 OK
Content-Type: application/json
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":null,"key":"String","id":"String"}}