API endpoint /credentials

[mjstealey]

/credentials

Endpoints

• /credentials paginated
• /credentials/{int:pk}

Functions

• search - by user_id as user.id == user_id or operator
• get one - by user_id as credential owner or operator
• create - as self - generate new key if public_key_credential not provided and return public / private portions
• delete - as self or as operator

Fields

--- /credentials
public_key_credential:  - string
public_key_expiration:  - string
public_key_id:          - int
public_key_name:        - string
user_id:                - int
--- /credentials/{int:pk}
created_date            - string
is_deleted              - boolean
is_expired:             - boolean
last_modified_by        - int
modified_date           - string
public_key_credential   - string
public_key_expiration   - int
public_key_id           - int
public_key_name         - string
user_id                 - int

Notes

POST

• when public_key_credential is included the value will be saved to the database and the response will include the normal detailed information
• when public_key_credential is NOT included a new key will be generated and the response will include the normal detailed information along with a one-time view of the private_key_credential

{
    "public_key_credential": "ssh-rsa AAAA...",   <-- optional
    "public_key_name": "user defined key name"    <-- required
}