Skip to main content

List Credentials

GET 

/credentials/

Call auditlog tasks if applicable to query.

Request

Query Parameters

    creator string
    is_sensitive boolean
    length integer

    Number of results to return per page.

    ordering string[]

    Possible values: [-created_at, -creator__name, -name, -updated_at, created_at, creator__name, name, updated_at]

    Ordering

    • name - Name
    • -name - Name (descending)
    • creator__name - Creator name
    • -creator__name - Creator name (descending)
    • updated_at - Updated at
    • -updated_at - Updated at (descending)
    • created_at - Created at
    • -created_at - Created at (descending)
    page integer

    A page number within the paginated result set.

    search string

    A search term.

    team string[]

    A unique Base58 value identifying this object.

Responses

Schema

    count integer

    Total number of results.

    page_total integer

    Total number of pages.

    page integer

    Number of the current page.
    The first page is 1.
    Defaults to 1 if no specific page is requested.

    length integer

    Number of results returned per page.

    results

    object[]

  • Array [

  • id stringrequired

    A unique Base58 value identifying this object.

    uri stringrequired
    name stringrequired

    Possible values: <= 255 characters

    team stringnullable

    A unique Base58 value identifying this object.

    description string

    Possible values: <= 1024 characters

    is_sensitive boolean
    value nullablerequired

    Value of credential. Returns null if sensitive.

    created_at date-timerequired
    updated_at date-timerequired

    creator

    object

    required

    id stringrequired

    A unique Base58 value identifying this object.

    email email

    Possible values: <= 254 characters

    Email of the user.

    name stringrequired

    Possible values: <= 60 characters

    Name of the user.

    usage_count integerrequired
  • ]

Loading...