ckanext-passwordless_api (1.1.8)

Download OpenAPI specification:Download

Extension to allow paswordless login to the CKAN API.

Email Key

Request a reset key (login token) to be sent by email.

Request Body schema: application/json

email

string

Responses

Request samples

Payload

Content type

application/json

{"email": "string"
}

Response samples

200
400
409

Content type

application/json

{"help": "http://localhost:8989/api/3/action/help_show?name=passwordless_request_reset_key",
"success": true,
"result": {"message": "success"
}
}

Request API Token

Get API token for a user, if reset key valid.

Request Body schema: application/json

email	string
key	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"key": "string"
}

Response samples

200
400
409

Content type

application/json

{"help": "http://localhost:8989/api/3/action/help_show?name=passwordless_request_api_token",
"success": true,
"result": {"token": "API_TOKEN"
}
}

Request API Token (Azure)

Get API token for a user, if Azure AD auth code valid.

Request Body schema: application/json

email	string
token	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"token": "string"
}

Response samples

200
400
409

Content type

application/json

{"help": "http://localhost:8989/api/3/action/help_show?name=passwordless_request_api_token",
"success": true,
"result": {"token": "API_TOKEN"
}
}

Revoke API token

If logged in, revoke API token used during endpoint call.

Responses

Response samples

200

Content type

application/json

Example

success

{"help": "http://localhost:8989/api/3/action/help_show?name=passwordless_revoke_api_token",
"success": true,
"result": {"message": "success"
}
}

Revoke API token

Revoke API token for a user, without requiring auth.

Request Body schema: application/json

token

string

Responses

Request samples

Payload

Content type

application/json

{"token": "string"
}

Response samples

200
400
409

Content type

application/json

{"help": "http://localhost:8989/api/3/action/help_show?name=passwordless_revoke_api_token",
"success": true,
"result": {"message": "success"
}
}

Get user

Get current user details & renew their API token.

Responses

Response samples

200

Content type

application/json

Example

success

{"help": "http://localhost:8989/api/3/action/help_show?name=passwordless_get_user",
"success": true,
"result": {"user": {"id": "USER_ID",
"name": "USERNAME",
"fullname": "USER_FULLNAME",
"created": "2021-11-11T11:52:06.681420",
"about": null,
"activity_streams_email_notifications": false,
"sysadmin": false,
"state": "active",
"image_url": null,
"display_name": "USER_DISPLAY_NAME",
"email_hash": "EMAIL_HASH",
"number_created_packages": 1,
"apikey": "USER_API_KEY(Deprecated)",
"email": "USER_EMAIL",
"image_display_url": null
},
"token": "NEW_API_TOKEN"
}
}

Validate token

Validate the current users API token.

Responses

Response samples

200

Content type

application/json

Example

success

true