AuthN | Python SDK | Agreements Endpoints

Agreements Endpoints

Create an agreement

authn.agreements.create(type, name, text, active)

Create an agreement.

required parameters

type

m.AgreementType

An agreement type

name

str

A name to describe the agreement.

text

str

The body of the agreement.

optional parameters

active

bool

A flag to that marks which of the agreements is currently active.

Response Object

A PangeaResponse with a EULA object in the response.result field. Available response fields can be found in our API Documentation.

response = authn.agreements.create(
    type=AgreementType.EULA,
    name="EULA_V1",
    text="You agree to behave yourself while logged in.",
)

Delete an agreement

authn.agreements.delete(type, id)

Delete an agreement.

required parameters

type

m.AgreementType

An agreement type

id

str

An ID for an agreement

Response Object

A PangeaResponse with an empty object in the response.result field.

authn.agreements.delete(
    type=AgreementType.EULA,
    id="peu_wuk7tvtpswyjtlsx52b7yyi2l7zotv4a",
)

List agreements

authn.agreements.list(filter, last, order, order_by, size)

List agreements.

optional parameters

filter

dict

last

str

Reflected value from a previous response to obtain the next page of results.

order

str

Order results asc(ending) or desc(ending).

order_by

str

Which field to order results by.

size

int

Maximum results to include in the response. Minimum: 1.

Response Object

A PangeaResponse with a list of EULA objects in the response.result field. Available response fields can be found in our API Documentation.

response = authn.agreements.list()

Update agreement

authn.agreements.update(type, id, name, text, active)

Update agreement.

required parameters

type

m.AgreementType

An agreement type

id

str

An ID for an agreement

optional parameters

name

str

The name of the agreement.

text

str

The body of the agreement.

active

bool

A flag to that marks which of the agreements is currently active.

Response Object

A PangeaResponse with the updated EULA object in the response.result field. Available response fields can be found in our API Documentation.

response = authn.agreements.update(
    type=AgreementType.EULA,
    id="peu_wuk7tvtpswyjtlsx52b7yyi2l7zotv4a",
    text="You agree to behave yourself while logged in. Don't be evil.",
    active=True,
)