FirstChoice.API

<back to all web services

RegenerateApiKeys

auth
Requires Authentication
The following routes are available for this service:
All Verbs/apikeys/regenerate
All Verbs/apikeys/regenerate/{Environment}
"use strict";
export class UserApiKey {
    /** @param {{Key?:string,KeyType?:string,ExpiryDate?:string,Meta?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    KeyType;
    /** @type {?string} */
    ExpiryDate;
    /** @type {{ [index:string]: string; }} */
    Meta;
}
export class RegenerateApiKeysResponse {
    /** @param {{Results?:UserApiKey[],Meta?:{ [index:string]: string; },ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {UserApiKey[]} */
    Results;
    /** @type {{ [index:string]: string; }} */
    Meta;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class RegenerateApiKeys {
    /** @param {{Environment?:string,Meta?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Environment;
    /** @type {{ [index:string]: string; }} */
    Meta;
}

JavaScript RegenerateApiKeys DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /apikeys/regenerate HTTP/1.1 
Host: staging-api.my1stchoicefs.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Environment":"String","Meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"Key":"String","KeyType":"String","ExpiryDate":"0001-01-01T00:00:00.0000000","Meta":{"String":"String"}}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}