Get Credentials for Integration - Cloud Security API

{"type":"api","title":"Get Credentials for Integration","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/67c4f058ec451812ff806264657c6fa63e72c844/ac5e908c-3245-3ba5-9e49-5ab5d54d743e","info":{"title":"Cisco Secure Access Third-Party Integrations API","version":"1.0.0","description":"Create and manage the third-party applications integrated with Secure Access.\nSecure Access integrates with third-party applications, which support either REST APIs or Webhooks.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Integrations","description":"Integration management"},{"name":"Credentials","description":"Credential management"},{"name":"Integration Types","description":"Integration types"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/admin/third-party-integrations-overview.md","uri":"secure-access-api-reference-third-party-integrations-overview"}},"openapi":"3.1.0","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"admin/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"admin.integrations:write":"Update, delete integrations","admin.integrations:read":"Read integrations"}}}}}},"spec":{"summary":"Get Credentials for Integration","operationId":"getCredentialsForIntegration","description":"Get the credentials by ID for an integration.","security":[{"oauthFlow":["admin.integrations:read"]}],"tags":["Credentials","Secure Access"],"parameters":[{"description":"The ID of the integration.","in":"path","name":"intId","required":true,"schema":{"type":"string"},"example":"1235678a","$$ref":"#/components/parameters/integrationId"},{"description":"The ID of the credentials for the integration.","in":"path","name":"credId","required":true,"schema":{"type":"string"},"example":"123asfjakljlksdf","$$ref":"#/components/parameters/credentialId"}],"responses":{"200":{"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The date and time (ISO 8601-formatted timestamp) when the system returned the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the credential returned in the response.","properties":{"credential":{"type":"object","description":"The properties of the credentials resource.","properties":{"createdAt":{"description":"The date and time when the system created the credentials for the integration.","format":"date-time","type":"string","example":"2024-01-15T10:30:00Z","$$ref":"#/components/schemas/credentialCreatedAt"},"createdBy":{"description":"The username of the administrator who created the credentials for the integration.","type":"string","example":"user@admin.com","$$ref":"#/components/schemas/credentialCreatedBy"},"createdFromIp":{"type":"string","description":"The IP address of the device or network where the integration was created.","example":"192.168.1.100","$$ref":"#/components/schemas/createdFromIp"},"href":{"description":"The URL for the credentials resource.","type":"string","example":"https://api.sse.cisco.com/admin/v2/integrations/123/credentials/456","$$ref":"#/components/schemas/credentialHref"},"name":{"description":"The name of the credentials.","type":"string","example":"credential one","$$ref":"#/components/schemas/credentialName"},"tags":{"type":"array","description":"The list of tags associated with the credentials.","items":{"type":"string","description":"The tag associated with the credentials."},"example":["credential one"],"$$ref":"#/components/schemas/credentialTags"},"type":{"description":"The authentication method used to obtain the credential.","enum":["google-service-account","basic-auth","piam-token","iroh-token"],"type":"string","example":"piam-token","$$ref":"#/components/schemas/credentialType"},"value":{"type":"object","description":"The properties of the value object in the credentials.","properties":{"href":{"description":"The URL for the credentials resource.","type":"string","example":"https://api.sse.cisco.com/admin/v2/integrations/123/credentials/456","$$ref":"#/components/schemas/credentialHref"},"password":{"description":"The password for the credential.","type":"string","example":"SecurePassword124!"},"serviceAccountId":{"description":"The ID of the Service Account.","type":"string","example":"service-account-123"},"serviceAccountKey":{"description":"The key for the Service Account.","type":"string","example":"-----BEGIN PRIVATE KEY-----\n MIIEvQ..."},"token":{"description":"The access token for the authentication of the credentials.","type":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"username":{"description":"The username associated with the credential.","type":"string"}},"example":{"username":"api_user","password":"secure_password123","token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"},"$$ref":"#/components/schemas/credentialValue"}},"required":["href","name","type","value","tags","createdBy","createdAt","createdFromIp"],"example":{"createdBy":"admin@company.com","createdAt":"2024-01-15T10:30:00Z","createdFromIp":"10.1.1.50","href":"https://api.sse.cisco.com/admin/v2/integrations/123/credentials/456","name":"Database Credential","type":"basic-auth","tags":["database","production"],"value":{"username":"db_user","password":"encrypted_password"}},"$$ref":"#/components/schemas/Credential"},"href":{"description":"The URL for the integration.","type":"string","example":"https://api.sse.cisco.com/admin/v2/integrations/123","$$ref":"#/components/schemas/integrationHref"},"value":{"type":"object","description":"The properties of the value object for a credential.","properties":{"value":{"type":"object","description":"The properties of the value object in the credentials.","properties":{"href":{"description":"The URL for the credentials resource.","type":"string","example":"https://api.sse.cisco.com/admin/v2/integrations/123/credentials/456","$$ref":"#/components/schemas/credentialHref"},"password":{"description":"The password for the credential.","type":"string","example":"SecurePassword124!"},"serviceAccountId":{"description":"The ID of the Service Account.","type":"string","example":"service-account-123"},"serviceAccountKey":{"description":"The key for the Service Account.","type":"string","example":"-----BEGIN PRIVATE KEY-----\n MIIEvQ..."},"token":{"description":"The access token for the authentication of the credentials.","type":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"username":{"description":"The username associated with the credential.","type":"string"}},"example":{"username":"api_user","password":"secure_password123","token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"},"$$ref":"#/components/schemas/credentialValue"}},"required":["value"],"example":{"value":{"username":"api_user","password":"secure_password123"}},"$$ref":"#/components/schemas/GetValueOutputBody"}},"required":["credential"],"example":{"credential":{"createdBy":"admin@company.com","createdAt":"2024-01-15T10:30:00Z","createdFromIp":"10.1.1.50","href":"https://api.sse.cisco.com/admin/v2/integrations/123/credentials/456","name":"API Key Credential","type":"piam-token","tags":["api","secure"],"value":{"token":"sample_token_value"}}},"$$ref":"#/components/schemas/GetCredentialOutputBody"}}},"description":"OK"},"400":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The date and time (ISO 8601-formatted timestamp) when the system returned the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Bad Request","example":"Not found IAM key info for org 12355."},"status":{"type":"integer","description":"The HTTP status code returned in the response.","example":400}}}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The date and time (ISO 8601-formatted timestamp) when the system returned the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Unauthorized","example":"Authorization token is invalid."},"status":{"type":"integer","description":"The HTTP status code returned in the response.","example":401}}}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The date and time (ISO 8601-formatted timestamp) when the system returned the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Forbidden"},"status":{"type":"integer","description":"The HTTP status code returned in the response.","example":403}}}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The date and time (ISO 8601-formatted timestamp) when the system returned the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Found"},"status":{"type":"integer","description":"The HTTP status code returned in the response.","example":404}}}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The date and time (ISO 8601-formatted timestamp) when the system returned the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Internal Server Error"},"status":{"type":"integer","description":"The HTTP status code returned in the response.","example":500}}}}},"$$ref":"#/components/responses/500Error"}},"method":"get","path":"/integrations/{intId}/credentials/{credId}"}}