Foundry API

<back to all web services

CreateApiKeyRequest

Requires Authentication
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 .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"}}