Org General Settings

The Org General Settings API provides operations to manage the general settings of your Okta org.

Retrieve the Org general settings
OAuth 2.0: `okta.orgs.read`

Retrieves the Org General Settings

Responses

200

Success

403

Forbidden

429

Too Many Requests

get/api/v1/org

Request samples

Response samples

application/json

{"address1": "100 1st St",
"address2": "6th floor",
"city": "San Fransico",
"companyName": "okta",
"country": "United States",
"endUserSupportHelpURL": "support.okta.com",
"phoneNumber": "+18887227871",
"postalCode": "94105",
"state": "California",
"supportPhoneNumber": "+18887227871",
"website": "www.okta.com",
"id": "00o3qqiw0vSCIwu8I0g7",
"created": "2024-01-24T14:15:22Z",
"lastUpdated": "2024-07-21T14:15:22Z",
"expiresAt": "2024-12-24T14:15:22Z",
"status": "ACTIVE",
"subdomain": "okta",
"_links": {"preferences": {"href": "https://{yourOktaDomain}/v1/org/preferences"
},
"uploadLogo": {"href": "https://{yourOktaDomain}/api/v1/org/logo",
"hints": {"allow": ["POST"
]
}
},
"oktaCommunication": {"href": "https://{yourOktaDomain}/api/v1/org/privacy/oktaCommunication"
},
"logo": null,
"oktaSupport": {"href": "https://{yourOktaDomain}/api/v1/org/privacy/oktaSupport"
},
"contacts": {"href": "https://vantest.oktapreview.com/api/v1/org/contacts"
}
}
}

Update the Org general settings
OAuth 2.0: `okta.orgs.manage`

Updates partial Org General Settings

Request

Request Body schema: application/json

address1	string Primary address of the organization associated with the org
address2	string Secondary address of the organization associated with the org
city	string City of the organization associated with the org
companyName	string Name of org
country	string County of the organization associated with the org
endUserSupportHelpURL	string Support link of org
phoneNumber	string Phone number of the organization associated with the org
postalCode	string Postal code of the organization associated with the org
state	string State of the organization associated with the org
supportPhoneNumber	string Support help phone of the organization associated with the org
website	string Website of the organization associated with the org

Responses

200

Success

400

Bad Request

403

Forbidden

429

Too Many Requests

post/api/v1/org

Request samples

application/json

{"address1": "100 1st St",
"address2": "6th floor",
"city": "San Fransico",
"companyName": "okta",
"country": "United States",
"endUserSupportHelpURL": "support.okta.com",
"phoneNumber": "+18887227871",
"postalCode": "94105",
"state": "California",
"supportPhoneNumber": "+18887227871",
"website": "www.okta.com"
}

Response samples

application/json

{"address1": "100 1st St",
"address2": "6th floor",
"city": "San Fransico",
"companyName": "okta",
"country": "United States",
"endUserSupportHelpURL": "support.okta.com",
"phoneNumber": "+18887227871",
"postalCode": "94105",
"state": "California",
"supportPhoneNumber": "+18887227871",
"website": "www.okta.com",
"id": "00o3qqiw0vSCIwu8I0g7",
"created": "2024-01-24T14:15:22Z",
"lastUpdated": "2024-07-21T14:15:22Z",
"expiresAt": "2024-12-24T14:15:22Z",
"status": "ACTIVE",
"subdomain": "okta",
"_links": {"preferences": {"href": "https://{yourOktaDomain}/v1/org/preferences"
},
"uploadLogo": {"href": "https://{yourOktaDomain}/api/v1/org/logo",
"hints": {"allow": ["POST"
]
}
},
"oktaCommunication": {"href": "https://{yourOktaDomain}/api/v1/org/privacy/oktaCommunication"
},
"logo": null,
"oktaSupport": {"href": "https://{yourOktaDomain}/api/v1/org/privacy/oktaSupport"
},
"contacts": {"href": "https://vantest.oktapreview.com/api/v1/org/contacts"
}
}
}

Replace the Org general settings
OAuth 2.0: `okta.orgs.manage`

Replaces the Org General Settings for your Okta org

Request

Request Body schema: application/json
required

address1	string Primary address of the organization associated with the org
address2	string Secondary address of the organization associated with the org
city	string City of the organization associated with the org
companyName	string Name of org
country	string County of the organization associated with the org
endUserSupportHelpURL	string Support link of org
phoneNumber	string Phone number of the organization associated with the org
postalCode	string Postal code of the organization associated with the org
state	string State of the organization associated with the org
supportPhoneNumber	string Support help phone of the organization associated with the org
website	string Website of the organization associated with the org

Responses

200

Success

400

Bad Request

403

Forbidden

429

Too Many Requests

put/api/v1/org

Request samples

application/json

{"address1": "100 1st St",
"address2": "6th floor",
"city": "San Fransico",
"companyName": "okta",
"country": "United States",
"endUserSupportHelpURL": "support.okta.com",
"phoneNumber": "+18887227871",
"postalCode": "94105",
"state": "California",
"supportPhoneNumber": "+18887227871",
"website": "www.okta.com"
}

Response samples

application/json

{"address1": "100 1st St",
"address2": "6th floor",
"city": "San Fransico",
"companyName": "okta",
"country": "United States",
"endUserSupportHelpURL": "support.okta.com",
"phoneNumber": "+18887227871",
"postalCode": "94105",
"state": "California",
"supportPhoneNumber": "+18887227871",
"website": "www.okta.com",
"id": "00o3qqiw0vSCIwu8I0g7",
"created": "2024-01-24T14:15:22Z",
"lastUpdated": "2024-07-21T14:15:22Z",
"expiresAt": "2024-12-24T14:15:22Z",
"status": "ACTIVE",
"subdomain": "okta",
"_links": {"preferences": {"href": "https://{yourOktaDomain}/v1/org/preferences"
},
"uploadLogo": {"href": "https://{yourOktaDomain}/api/v1/org/logo",
"hints": {"allow": ["POST"
]
}
},
"oktaCommunication": {"href": "https://{yourOktaDomain}/api/v1/org/privacy/oktaCommunication"
},
"logo": null,
"oktaSupport": {"href": "https://{yourOktaDomain}/api/v1/org/privacy/oktaSupport"
},
"contacts": {"href": "https://vantest.oktapreview.com/api/v1/org/contacts"
}
}
}

Social
CONTACT & LEGAL
MORE INFORMATION
okta.com
Products, case studies, resources
Help Center
Knowledgebase, roadmaps, and more
Trust
System status, security, compliance

Org General Settings

Retrieve the Org general settingsOAuth 2.0: okta.orgs.read

Update the Org general settingsOAuth 2.0: okta.orgs.manage

Request Body schema: application/json

Replace the Org general settingsOAuth 2.0: okta.orgs.manage

Request Body schema: application/jsonrequired

Retrieve the Org general settings
OAuth 2.0: `okta.orgs.read`

Update the Org general settings
OAuth 2.0: `okta.orgs.manage`

Replace the Org general settings
OAuth 2.0: `okta.orgs.manage`

Request Body schema: application/json
required