---
sourceDocument: Xanadu API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# StandardCredentialsProvider - Scoped, Global

# StandardCredentialsProvider - Scoped, Global {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read

The StandardCredentialsProvider API provides methods to retrieve
credential information.

You can use this API in scoped applications or within the global scope. In scoped scripts,
use the `sn_cc` namespace identifier.

This API provides methods to retrieve credential information by sys_id and by specified
credential attributes.  

    //Get a single credential

    var provider = new sn_cc.StandardCredentialsProvider();
    var credential = provider.getCredentialByID("f43c6d40a0a0b5700c77f9bf387afe3");
    var userName = credential.getAttribute("user_name");
    var password = credential.getAttribute("password");
    //using getAttribute for new keys in extended tables, for example 
    //cloud management credential has the "user_public_key" attribute
    var userPublicKey = credential.getAttribute("user_public_key");

    //Get a list of SSH credentials

    var provider = new sn_cc.StandardCredentialsProvider();
    var credentials = provider.getCredentials(["ssh"]);
    for (var i = 0; i < credentials.length; i++) {
      var credential = credentials[i];
      gs.info(credential.getAttribute("name"));
    }

## StandardCredentialsProvider - StandardCredentialsProvider() {#ariaid-title2}

Instantiates a credentials provider object.
{#SCP-standard-credential-provider__table_afx_pp2_qbb__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 1. Parameters]

{#SCP-standard-credential-provider__table_afx_pp2_qbb}  

    var provider = new sn_cc.StandardCredentialsProvider();
    var credentials = provider.getCredentialByID("ef43c6d40a0a0b5700c77f9bf387afe3");

## StandardCredentialsProvider - getCredentials(String types, String tags) {#ariaid-title3}

Returns an array of all credentials that match the specified types and
tags.
{#SCP-getCredentials_S__table_xxn_xq2_qbb__entry__3}

| Name | Type | Description |
|-|-|-|
| tags | String | Optional. Comma-separated list of tag names. For example, "ssh, jdbc". Examples of valid calls: * ` var credentials = provider.getCredentials(null, null);` * `var credentials = provider.getCredentials(["ssh"], "");` * `var credentials = provider.getCredentials(new ArrayList<String>(), "ssh,admin");` {#SCP-getCredentials_S__ul_fsr_sf2_4nb} |
| types | Array | Optional. Credential type names. For example, \["ssh", "windows"\] Note: If types is null or empty, any match returns a credential. If types is specified, the credentials whose type matches one of the types is returned. |
[Table 2. Parameters]

{#SCP-getCredentials_S__table_xxn_xq2_qbb} {#SCP-getCredentials_S__table_yxn_xq2_qbb__entry__2}

| Type | Description |
|-|-|
| StandardCredential | Credential record object. |
[Table 3. Returns]

{#SCP-getCredentials_S__table_yxn_xq2_qbb}  
This code example shows how to get the provider credentials for "ssh" credential types.

    var provider = new sn_cc.StandardCredentialsProvider();
    var credentials = provider.getCredentials(["ssh"]);

This code example shows how to get the provider credentials for "ssh" and "windows"
credential types that have tags of "admin".

    var provider = new sn_cc.StandardCredentialsProvider();
    ArrayList<String> types = new ArrayList<>();
    types.add("ssh");
    types.add("windows");
    JSONArray jsonArray = provider.getCredentials(types, "admin");

## StandardCredentialsProvider - getCredentialByAliasID(String sys_id) {#ariaid-title4}

Returns the credential record object through its credential alias (sys_alias).
This method is specifically for use with credential types. For information, see [Credential aliases for Discovery](https://www.servicenow.com/docs/access?context=discovery-credential-alias&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US).
{#SCP-getCredentialByAliasID_S__table_xxn_xq2_qbb__entry__3}

| Name | Type | Description |
|-|-|-|
| sys_id | String | Sys_id of the credential alias record in the Connection \& Credential Aliases \[sys_alias\] table. |
[Table 4. Parameters]

{#SCP-getCredentialByAliasID_S__table_xxn_xq2_qbb} {#SCP-getCredentialByAliasID_S__table_yxn_xq2_qbb__entry__2}

| Type | Description |
|-|-|
| StandardCredential | Credential record object. |
[Table 5. Returns]

{#SCP-getCredentialByAliasID_S__table_yxn_xq2_qbb}  
The following example retrieves a credential using the alias ID and displays the user name.

    var provider = new sn_cc.StandardCredentialsProvider();
    var aliasCred = provider.getCredentialByAliasID("752a91887740001038e286a2681061fb");
    gs.info("User name: " + aliasCred.getAttribute("user_name"));

Output for a credential record with a user name:

    User name: Dara Lee

## StandardCredentialsProvider - getCredentialByID(String sys_id) {#ariaid-title5}

Returns the credential record object identified by the specified sys_id.
{#SCP-getCredentialByID_S__table_xxn_xq2_qbb__entry__3}

| Name | Type | Description |
|-|-|-|
| sys_id | String | Sys_id of the credential record. Located in the Credentials \[discovery_credentials\] table. |
[Table 6. Parameters]

{#SCP-getCredentialByID_S__table_xxn_xq2_qbb} {#SCP-getCredentialByID_S__table_yxn_xq2_qbb__entry__2}

| Type | Description |
|-|-|
| StandardCredential | Credential record object. |
[Table 7. Returns]

{#SCP-getCredentialByID_S__table_yxn_xq2_qbb}  
The following example retrieves a credential and displays the user name.

    var provider = new sn_cc.StandardCredentialsProvider();
    var credentials = provider.getCredentialByID("ef43c6d40a0a0b5700c77f9bf387afe3");
    gs.info("User name: " + credentials.getAttribute("user_name"));

Output for a credential record with a user name:

    User name: Dara Lee