Updates an organization.

put

https://api.9line911.com/v1/organizations/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The organization ID.

Body Params

The request.

The request for updating an existing organization.

organizationId

string | null

The organization ID.

name

string

required

length ≥ 1

The organization name.

description

string | null

A description of the organization.

geolocationId

string | null

The organization name.

autoActivateNewUsers

boolean

A value indicating whether users that are discovered through system integrations in this organization are automatically sent a welcome email. Defaults to false.

emergencyCallNotificationEmailAddress

string

required

length ≥ 1

The email address where notifications are sent when a 911 or 933 call is placed.

defaultEmergencyPhoneNumber

string

required

length ≥ 1

The emergency phone number (defaut ELIN) used when call to 911 or 933 is received by 9Line but does not have a calling number specified.

is911ServiceEnabled

boolean

A value indicating whether 911 calling is enabled for the organization. When false, 911 calls will not be connected by 9Line.
Calls to 933 will always be connected to the test service regardless of this value. Defaults to false.

features

string

enum

isSingleSignOnEnabled

boolean

A value indicating whether Single Sign-on is enabled for the organization. When false, users must login using credentials unique to 9Line.
When true, Single Sign-on will be utilized for the organization. Defaults to false.

ssoProtocol

string

enum

Allowed:

ssoIdentityProvider

string

enum

Allowed:

ssoDomain

string | null

deprecated

The domain to associate users with respective IdP. This will be used for new users during the login process.

ssoDomains

array of strings | null

Gets or sets the SSO Domains.

ssoDomains

ssoEntityId

string | null

The Entity ID of the SSO service, usually the Name or URL. This will be validated during the login/logout process.

ssoIssuer

string | null

The Entity ID of the identity provider (IdP), usually the Name or URL. This will be validated during the login/logout process.

ssoSignInUrl

string | null

The SSO sign-in URL. Login flows will be sent here.

ssoSignOutUrl

string | null

The SSO sign-out URL. Logout flows will be sent here.

ssoBinding

string

enum

Allowed:

ssoCertificate

string | null

The SSO public X509 signing certificate in base64 format. This is used to validate the signature of all SSO requests.

isSamlResponseAssertionEncryptionEnabled

boolean

A value indicating whether Single Sign-on SAML2 Response Assertion Encryption is enabled for the organization.
When true, the SAML Response will be treated as if the Assertion is encrypted using 9Line's public X509 Certificate.

ssSamlRequestSigningEnabled

boolean

Gets or sets a value indicating whether Single Sign-On SAML2 Request Signing is enabled for the organization.
When true, the SAML AuthNRequest will be signed using 9Line's public X509 Certificate.

Responses

200

OK when successful with the organization in the body.

400

BAD REQUEST if any validation errors occur.

401

UNAUTHORIZED when the access token is invalid or expired.

403

FORBIDDEN when access to the organization is prohibited with the provided credentials on the request.

404

NOT FOUND when the organization is not found.

500

INTERNAL SERVER ERROR on any unexpected errors.