fasjson.web.resources package

Submodules

fasjson.web.resources.base module

class fasjson.web.resources.base.Namespace(name, description=None, path=None, decorators=None, validate=None, authorizations=None, ordered=False, **kwargs)

Bases: Namespace

add_resource(resource, *urls, **kwargs)

Each API endpoint can return 401 if authentication is not successful.

marshal_with(fields, *args, **kwargs)

A decorator specifying the fields to use for serialization.

Parameters:

• as_list (bool) – Indicate that the return type is a list (for the documentation)

• code (int) – Optionally give the expected HTTP response code if its different from 200

marshal_with_field(field, *args, description=None)

paged_marshal_with(model, description=None, **marshal_kwargs)

A decorator to call paged_marshal. See Namespace.marshal_with for reference.

fasjson.web.resources.certs module

class fasjson.web.resources.certs.Base64Dict(*args, **kwargs)

Bases: String

IPA returns this weird structure in certificate chains

output(key, obj, ordered=False, **kwargs)

Pulls the value for the given key from the object, applies the field’s formatting and returns the result. If the key is not found in the object, returns the default value. Field classes that create values which do not require the existence of the key in the object should override this and return the desired value.

Raises:

MarshallingError – In case of formatting problem

class fasjson.web.resources.certs.Cert(api=None, *args, **kwargs)

Bases: Resource

endpoint = 'certs_cert'

get(serial_number)

Fetch a certificate given its serial number

Certificates are also present on users’ results, but this method gives more details.

mediatypes()

methods: ClassVar[Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class fasjson.web.resources.certs.Certs(api=None, *args, **kwargs)

Bases: Resource

endpoint = 'certs_certs'

mediatypes()

methods: ClassVar[Collection[str] | None] = {'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

post()

Send a CSR and get a signed certificate in return

fasjson.web.resources.groups module

class fasjson.web.resources.groups.Group(api=None, *args, **kwargs)

Bases: Resource

endpoint = 'groups_group'

get(groupname)

Fetch a group given their name

mediatypes()

methods: ClassVar[Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class fasjson.web.resources.groups.GroupList(api=None, *args, **kwargs)

Bases: Resource

endpoint = 'groups_group_list'

get()

List all groups

mediatypes()

methods: ClassVar[Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class fasjson.web.resources.groups.GroupMembers(api=None, *args, **kwargs)

Bases: Resource

endpoint = 'groups_group_members'

get(groupname)

Fetch group members given the group name

mediatypes()

methods: ClassVar[Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class fasjson.web.resources.groups.GroupSponsors(api=None, *args, **kwargs)

Bases: Resource

endpoint = 'groups_group_sponsors'

get(groupname)

Fetch group sponsors given the group name

mediatypes()

methods: ClassVar[Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class fasjson.web.resources.groups.IsMember(api=None, *args, **kwargs)

Bases: Resource

endpoint = 'groups_is_member'

get(groupname, username)

Check whether a user is a member of the group

mediatypes()

methods: ClassVar[Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

fasjson.web.resources.me module

class fasjson.web.resources.me.Me(api=None, *args, **kwargs)

Bases: Resource

endpoint = 'me_me'

get()

Fetch the connected user

mediatypes()

methods: ClassVar[Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

fasjson.web.resources.search module

class fasjson.web.resources.search.SearchUsers(api=None, *args, **kwargs)

Bases: Resource

endpoint = 'search_search_users'

get()

Fetch users given a search term

mediatypes()

methods: ClassVar[Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

fasjson.web.resources.users module

class fasjson.web.resources.users.User(api=None, *args, **kwargs)

Bases: Resource

endpoint = 'users_user'

get(username)

Fetch a user given their name

mediatypes()

methods: ClassVar[Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class fasjson.web.resources.users.UserAgreements(api=None, *args, **kwargs)

Bases: Resource

endpoint = 'users_user_agreements'

get(username)

Fetch a user’s agreements given their username

mediatypes()

methods: ClassVar[Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class fasjson.web.resources.users.UserGroups(api=None, *args, **kwargs)

Bases: Resource

endpoint = 'users_user_groups'

get(username)

Fetch a user’s groups given their username

mediatypes()

methods: ClassVar[Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class fasjson.web.resources.users.UserList(api=None, *args, **kwargs)

Bases: Resource

endpoint = 'users_user_list'

get()

List all users

mediatypes()

methods: ClassVar[Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

Module contents