Foundry API

ListApiKeysForCallerRequest

The following routes are available for this service:
GET	/auth/apikeys

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetOperationUnTenanted(Generic[TResponse], IReturn[TResponse], IHasGetOptions, IGet):
    embed: Optional[str] = None
    @staticmethod
    def response_type(): return TResponse


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchOperationUnTenanted(Generic[TResponse], GetOperationUnTenanted[TResponse], IHasSearchOptions):
    distinct: Optional[str] = None
    limit: Optional[int] = None
    offset: Optional[int] = None
    sort: Optional[str] = None
    filter: Optional[str] = None


class SortDirection(str, Enum):
    ASCENDING = 'Ascending'
    DESCENDING = 'Descending'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Sorting:
    by: Optional[str] = None
    direction: Optional[SortDirection] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Filtering:
    fields: Optional[List[str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchMetadata:
    total: Optional[int] = None
    limit: Optional[int] = None
    offset: Optional[int] = None
    sort: Optional[Sorting] = None
    filter: Optional[Filtering] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchOperationResponse:
    metadata: Optional[SearchMetadata] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiKey(IIdentifiableResource):
    user_id: Optional[str] = None
    description: Optional[str] = None
    expires_utc: Optional[datetime.datetime] = None
    key: Optional[str] = None
    id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListApiKeysForCallerResponse(SearchOperationResponse):
    response_status: Optional[ResponseStatus] = None
    api_keys: Optional[List[ApiKey]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListApiKeysForCallerRequest(SearchOperationUnTenanted[ListApiKeysForCallerResponse]):
    pass

Python ListApiKeysForCallerRequest 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.

GET /auth/apikeys HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/csv

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

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"apiKeys":[{"userId":"String","description":"String","expiresUtc":null,"key":"String","id":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"]}}}