Credential Entity

The following are the attributes in the body of a credential service.
Attribute Type Updatable Comments
 id  UUID  no (Required for PUT only)

For PUT the ID in body must valid ID and must match step on the URL.

For POST this is ignored.
 version  int  no Read-only.
 type  string  no (Required) The type of credential. Only “INCENT”, “SALESFORCE” and “WORKDAY” are supported.
name string yes (Required) A unique name given to this credential.
 username  string  yes (Required) The username (must be a valid username for this type of credentials).
 password  string  yes (Required) The password (must correspond to the username for this type of credentials).
 description  string  yes (Optional) description of this credential object
 createdInstant  datetime  no Read-only
createdBy  string  no Read-only. Username associated with session when creating
 modifiedInstant  datetime  no Read-only
 modifiedBy  string  no Read-only. Username associated with session when updating
attributes string no (Optional) Additional attribute name and value pairs that are required for various credentials.

Syntax

"attributes":{  
            "attr2":"val2",
            "attr1":"val1"
         }

List of APIs

Note: We have tried to keep this list up to date. However, for the most up to date list, see the interactive docs: https://connect-i1.xactlycorp.com/connect/docs/swagger-ui.html

POST /connect/v1/credentials
Creates a Credential for an external system of the given type.  Returns the resulting credential ID in the Location header.  Once you create a credential object you can not update it’s type but you can update the other updateable attributes.
DELETE /connect/v1/credentials/{id}
Delete a Credential from the repository. Exercise caution as this can not be undone.
GET /connect/v1/credentials
Get a paginated list of all Credential definitions. You can provide a page number (default 0) and a page size (default 100, max 1000).  A description of the pagination pattern and metadata can be found here: [LINK]
GET /connect/v1/credentials/{id}
Get a single Credential definition. You have to provide a valid Credential ID.
PUT /connect/v1/credentials/{id}
Update a Credential definition. You have to provide a valid Credential definition ID in the URL and in the payload. All updateable attributes can be updated but type can not be updated. The ID attribute or other read-only attributes can not be updated,