Validate Organization Credential

Select

SaaS

Customer Managed

Checks if the provided credential is valid and has basic organization permissions.
If the validation succeeds, details of the AWS organization corresponding to the credentials is returned.
Credential can be specified directly in the request or it can be saved as a credential manager entity and its id can be specified in the request

application/json

Request Body

• credential object required

  Credential to be used to be access AWS Organization

  credentialType AWSOrganizationCredentialType required

  Possible values: [CREDENTIALS_MANAGER_CREDENTIAL, AWS_STS_ASSUME_ROLE, AWS_IAM_ROLE]

  Type of credential to be used to access AWS Organization

  credentialId int32

  ID of the saved credential. Applicable only if credentialType is CREDENTIALS_MANAGER_CREDENTIAL.

  awsIamRoleArn string

  ARN of the IAM Role to assume. Applicable only if credentialType is AWS_ASSUME_ROLE.

  awsExternalId string

  External ID to use when assuming IAM Role. Applicable only if credentialType is AWS_ASSUME_ROLE.

• accessNodes object[] required

  List of servers and server groups to use to access the organization.

Responses

• 200
• 400
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• organization object

  Details of an AWS organization

  organizationId string

  Id of the AWS organization

  organizationArn string

  ARN of the AWS organization

  masterAccountId string

  Id of the AWS organization's management account

  masterAccountArn string

  ARN of the AWS organization's management account

  masterAccountEmail string

  E-mail of the AWS organization's management account

{
  "organization": {
    "organizationId": "string",
    "organizationArn": "string",
    "masterAccountId": "string",
    "masterAccountArn": "string",
    "masterAccountEmail": "string"
  }
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• errorType AWSOrganizationErrorType

  Possible values: [UNKNOWN, INVALID_REQUEST, ACCESS_NODE_COMMUNICATION_FAILED, SERVICE_ENDPOINT_NOT_REACHABLE, CREDENTIAL_INVALID, NOT_ENOUGH_PERMISSIONS, ALL_ACCOUNTS_FAILED_DISCOVERY]

  Type of AWS Organization specific error that occured

• errorMessage string

{
  "errorType": "UNKNOWN",
  "errorMessage": "string"
}

Internal Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

POST /v4/cloud/aws/organization/credential/validate    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

{
  "credential": {
    "credentialType": "CREDENTIALS_MANAGER_CREDENTIAL",
    "credentialId": 0,
    "awsIamRoleArn": "string",
    "awsExternalId": "string"
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "accessNodeType": "SERVER"
    }
  ]
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/AWS/Organization/Credential/Validate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credential": {
    "credentialType": "CREDENTIALS_MANAGER_CREDENTIAL",
    "credentialId": 0,
    "awsIamRoleArn": "string",
    "awsExternalId": "string"
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "accessNodeType": "SERVER"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/AWS/Organization/Credential/Validate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credential": {
    "credentialType": "CREDENTIALS_MANAGER_CREDENTIAL",
    "credentialId": 0,
    "awsIamRoleArn": "string",
    "awsExternalId": "string"
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "accessNodeType": "SERVER"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/AWS/Organization/Credential/Validate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credential": {
    "credentialType": "CREDENTIALS_MANAGER_CREDENTIAL",
    "credentialId": 0,
    "awsIamRoleArn": "string",
    "awsExternalId": "string"
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "accessNodeType": "SERVER"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/AWS/Organization/Credential/Validate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credential": {
    "credentialType": "CREDENTIALS_MANAGER_CREDENTIAL",
    "credentialId": 0,
    "awsIamRoleArn": "string",
    "awsExternalId": "string"
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "accessNodeType": "SERVER"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/AWS/Organization/Credential/Validate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credential": {
    "credentialType": "CREDENTIALS_MANAGER_CREDENTIAL",
    "credentialId": 0,
    "awsIamRoleArn": "string",
    "awsExternalId": "string"
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "accessNodeType": "SERVER"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/AWS/Organization/Credential/Validate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credential": {
    "credentialType": "CREDENTIALS_MANAGER_CREDENTIAL",
    "credentialId": 0,
    "awsIamRoleArn": "string",
    "awsExternalId": "string"
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "accessNodeType": "SERVER"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/AWS/Organization/Credential/Validate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credential": {
    "credentialType": "CREDENTIALS_MANAGER_CREDENTIAL",
    "credentialId": 0,
    "awsIamRoleArn": "string",
    "awsExternalId": "string"
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "accessNodeType": "SERVER"
    }
  ]
}'